dyarawilliams / study-buddy

Study Buddy is an app to keep track of your study notes. It lets you see all your assignments and deadlines in a single place.

Study Buddy

Description

Study Buddy App is built using MVC Architecture.

It is a lot keeping track of assignments, deadlines and completion dates and as such, we decided to build the Study Buddy Web App. It's an app to keep track of your study notes. It lets you see all your assignments and deadlines in a single place. The app is created to understand how MVC concept and logins are added

Built With

This app was built using:

• EJS
• Bootstrap
• Express Js

Installation

Install all the dependencies or node packages used for development via Terminal

npm install

• Create a .env file and add the following as key: value
  • PORT: 2121 (can be any port example: 3000)
  • DB_STRING: your database URI

Start the project with

npm start

Usage

Roadmap

• Add Changelog
• Add back to top links
• Add Study Group function
• Add notifications

See the open issues for a full list of proposed features (and known issues).

Credits

Collaborators

Made with contrib.rocks.

Packages/Dependencies used

bcrypt, connect-mongo, dotenv, ejs, express, express-flash, express-session, mongodb, mongoose, morgan, nodemon, passport, passport-local, validator

License

MIT

How to Contribute

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Project Link: https://github.com/your_username/repo_name

Acknowledgments

Inspiration, code snippets, etc.

• awesome-readme
• readme-template
• dbader
• zenorocha

Team assignments

https://docs.google.com/document/d/18SvBvun_Esu58Oxr1TaCZFI8xmBIkHmmvUD3mGptnSk/edit?usp=sharing

Next Group meeting

Thursday, 1st September 2022. 1pm EST

Saturday, 3rd September 2022. 1pm EST

Monday, 5th September 2022. 1pm EST

Have fun testing and improving it! 😎