- Description
- User Story
- Requirements
- Installation
- Usage
- Contribution
- Contact Information
- Future Developments
- Technology Used
Habit-Rabbit is a habit tracking app that offers the ability to add and track daily habits in order to promote self awareness. Our goal is to provide details that enable the user to adjust their habits according to their life goals.
AS A USER who wants to change bad habits
I WANT an app where I can track each habit
SO THAT I can stay consistent and accountable
- Use Node and Express server
- Use Handlebars template engine
- Must be backed by MYSQL database and include sequelize ORM
- Utilize GET and POST routes
- Must be deployed through Heroku with data
- Include one new technology, package or library
- Polished UI
- Proper MVC paradigm folder structure
- Quality code
- Must protect API keys with environmental variables
-
Open terminal
-
Clone the repo: https://github.com/Kfields91/Habit-Rabbit.git
-
cd into new directory
-
add a
.envfile into your directory (outside of folders) -
In
.envcreate variableDBPASSWORD=equal to your specific MySQL database password -
Npm i all the required dependancies in the package.json file
-
Run server.js
-
open localhost:8080 in your browser
- Run server.js
- open localhost:8080 in your browser
or
go directly to this Heroku link where the app is deployed
If you would like to contribute to this project reach out to our contributors. Contact Information can be found below in Contact Information
Repository
https://github.com/Kfields91/Habit-Rabbit
-
Creating a dynamic globol page where all users can choose to share their habit's progress and goals with others
-
Inspirational messaging for those in need of encouragment
-
Ability to chat with other users
-
a longer record of data (currently a week)
- Node.js
- express
- express-handlebars
- MySQL & Sequilize
- mysql2
- Passport
- Nodemon
- bcryptjs
- dotenv
- express-session