dainbrownlow08 / ruby-project-guidelines

A+D Planner

A+D Planner is a tool that allows computer users who are familiar with their terminal to do plan out their schedule. This application supports multiple user accounts, with their own individual schedules. They can create entries by providing a date and time for each, look over their daily, monthly, and yearly schedules, and maniuplate their entries in case of a change in plans.

Prerequisites

Before you begin, ensure you have met the following requirements:

• You have installed version <Ruby/2.6.1>
• You have installed (https://bundler.io/).
• You have a Windows/Mac machine.

Installing A+D Planner

To install A+D Planner, follow these steps:

1. Navigate to (https://github.com/dainbrownlow08/ruby-project-guidelines) to clone the project.
2. Create a directory where you would like to store the file.
3. Navigate into that directory and use the command: git clone <project-SSH>

Using A+D Planner

For a quick demo, follow the link (https://www.youtube.com/watch?v=UnLJFyOrODY&feature=youtu.be)

To use A+D Planner, follow these steps:

After forking, in your terminal type the following commands:

1. bundle install

2. rake db:migrate

3. alias planner="ruby ./bin/run.rb"

4. Type planner to begin using your planner.

If you would ever like to clear the entire planner: In your terminal type rake db:seed

Contributing to A+D Planner

To contribute to A+D Planner, follow these steps:

1. Fork this repository.
2. Create a branch: git checkout -b <branch_name>.
3. Make your changes and commit them: git commit -m '<commit_message>'
4. Push to the original branch: git push origin <project_name>/<location>
5. Create the pull request.

Alternatively see the GitHub documentation on creating a pull request.

Contributors

Thanks to the following people who have contributed to this project:

• @alexanderbowers 📖 🐛
• @dainbrownlow📖
• @benswanson📖

Contact

If you want to contact me you can reach us at [email protected], or [email protected].

License

This project uses the following license: Learn.co Educational Content License.