Skip to content

Latest commit

 

History

History
81 lines (51 loc) · 1.78 KB

README.md

File metadata and controls

81 lines (51 loc) · 1.78 KB
Raw

habit-tracker-api

A Node.js API for tracking daily habits and building streaks!

This project provides a RESTful API to manage user-defined habits and track daily progress. Users can set personal goals, view streaks, and gain insights into their consistency to stay motivated.

Table of Contents

Features

  • User Authentication: Secure user login and registration.
  • Habit Management: Create, update, view, and delete habits.
  • Daily Tracking: Log progress for each habit daily.
  • Streak Tracking: Track consecutive days a habit is completed.
  • Analytics: Gain insights on habit consistency and completion rates.
  • Reminders: Option to set daily reminders for habit tracking.

Tech Stack

Will be updated soon!

Getting Started

Prerequisites

  • Node.js

Installation

1. Clone the Repository:

git clone https://github.com/username/habit-tracker.git
cd habit-tracker

2. Install Dependencies:

npm install

API Endpoints

Will be updated soon!

Authentication

User authentication

Habit Management

Manage habits

Daily Tracking

Log daily progress and view logs

Streaks and Analytics

Get habit streaks and user progress summary

Data Models

Will be updated soon!

Future Improvements

  • Social Sharing: Allow users to share their achievements.
  • Leaderboard: Display top users based on streaks or consistency.
  • Customizable Goals: Allow users to set specific goals or targets for each habit.

License

This project is licensed under the MIT License. See the LICENSE file for more details.