README.md Sections:
Introduction
Timeato is an open source pomodoro study buddy built in JavaScript. Our platform aims to provide users the ability to increase productivity while setting aside time to study and do work. Create an account and start tracking study session information. After we authenticate you as a user, we are able to track the amount of time you have spent studying each of your selected tasks.
Project Installation
- Fork our repository
- Navigate to a local directory where you would like the project to be cloned to
- Clone the repository to your local environment (
git clone <link here>) - Install all of our dependencies (
npm installornpm i) - Create a
.envfile and add the following variables:- DB_STRING =
mongodb connection URI. - SECRET_SESSION =
string secret to pass into express-session instance.
- DB_STRING =
Project Dependencies
- bcrypt - used to encrypt user password information.
- connect-mongo - used for creating connection to mongodb database.
- dotenv - used to process environment variables
- ejs - used as view engine to render html
- express - used for routing and handling request / response operations.
- express-flash - used to display error information to user when logging or signing up.
- express-session - used to maintain user state (such as if they are currently logged in or not).
- mongodb - database used to store web application data.
- mongoose - used for creating models and schemas for storing data properly.
- morgan - used for displaying request information in testing environment.
- nodemon - used for testing and speeding up development process.
- passport - used for user authentication.
- passport-local - passport strategy used.
- validator - used for validating user input.
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.
Please visit CONTRIBUTING.md to read about our guidelines before making a contribution to our project. Thank you!
Report a Bug
If you encounter a bug and/or have any suggestions for our team, please visit our issues page and create a new issue. If you wish to implement a feature on your own, please visit our Contributing Guidelines and follow our requirements.
If you have encountered a bug, please provide as much information as you can to help us replicate the issue on our own end. Depending on the issue, it may be useful to communicate your browser, screen width, and/or anything that relates to your specific encounter.