Habit Heatmap

A fun way to improve your lifestyle!
Explore the docs »

View Demo · Report Bug · Request Feature

No.	Section	Subsection
1	About The Project	Built With
2	Getting Started	Prerequisites
		Installation
3	Usage
4	Roadmap
5	Contributing
6	License
7	Contact
8	Acknowledgments

About The Project

Habit Heatmap is a web application that helps you track your habits and visualize your progress. It uses a heatmap to show you how well you are doing with your habits. The app is built with React, Tailwind, MongoDB, and Flask.

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

1. Get a free API Key at api ninjas

2. Clone the repo

   git clone https://github.com/IshmamF/habit-heatmap.git

3. Install NPM packages

   npm install cal-heatmap

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

Frontend

1. Install Node.js

2. Navigate to the frontend directory

3. Run the following command to install the required packages

   npm install

4. Run the following command to start the development server

    npm start

Backend

1. Install Python

2. Run the following command to install the required packages

   pip install -r requirements.txt

3. Run the following command to start the development server

    python server/server.py

(back to top)

CI/CD

Backend: https://habit-heatmap-api-d98a01d08072.herokuapp.com/api/v1/ping
Deployed on Heroku, Go to deploy-back github actions
Frontend: https://habit-heatmap.vercel.app/
Deployed on Vercel, Go to deploy-back github actions
Vercel has automatic updates so adding CD to github actions isn't necessary for frontend.

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Habit Metrics
• Accountability Partner
• Social Sharing
  • Allow users to share their progress on the app through posts and comments.

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

(back to top)

Contributing

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

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

• [email protected]
• [email protected]
• [email protected]

Project Link

https://github.com/IshmamF/habit-heatmap

(back to top)

Acknowledgments

• Ishmam Fardin
• Yared Pena
• Abrar Habib

(back to top)

Notes