Skip to content

Latest commit

 

History

History
72 lines (50 loc) · 1.84 KB

README.md

File metadata and controls

72 lines (50 loc) · 1.84 KB

Habit Tracker

Habit Tracker is a web application (PWA) built with Next.js that allows users to track their daily habits. Users can visualize their habit consistency with a heatmap, add, edit, and delete habits, and create an account to save their habits.

Hosted Website: habit-tracker.chaitanyashahare.com

Design Document: notes.chaitanyashahare.com/habit-tracker-app-design-document/

Features

  • Track daily habits
  • Visualize habit consistency with a heatmap
  • Add, edit, and delete habits
  • User authentication
  • Save habits to an account
  • Theme toggle
  • PWA

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • Node.js
  • npm

Installation

  1. Clone the repo 
      git clone https://github.com/Chaitanya-Shahare/habit-tracker.git
  2. Install NPM packages 
    npm install
  3. Start the development server 
    npm run dev
  4. Open http://localhost:3000 with your browser to see the result.

Usage

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.

  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

License

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

Contact

Chaitanya Shahare - [email protected]