Shuukan

Shuukan is a habit tracking web application designed to help users build and maintain positive habits through a visual streak-based system.

Table of Contents

1. Introduction
2. Features
3. Installation
4. Usage
5. Contributing
6. License

Introduction

Shuukan encourages users to develop productive habits by tracking daily progress and providing visual feedback. The app is inspired by GitHub's contribution graph, offering a streak-based system to motivate habit consistency.

Features

• Habit Management: Create, edit, and delete habits.
• Streak Tracking: Visualize streaks and view historical streak data.
• Calendar Visualization: GitHub-style contribution calendar for habit completion history.
• Privacy-Focused: Data stored locally using the browser's localStorage.

Installation

To set up the project locally, ensure you have Node.js and npm installed.

1. Clone the repository:

   git clone https://github.com/yourusername/shuukan.git
   cd shuukan

2. Install dependencies:

   npm install

3. Run the application:

   npm start

4. Open your web browser and navigate to http://localhost:3000 to see Shuukan in action.

Usage

• Visit the landing page and click "Get Started" to create and manage your habits.
• Use the dashboard to add new habits and check off completed habits daily.
• View your progress on the calendar with streak counts and habit history.

Contributing

We welcome contributions from the community! To contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/YourFeature).
3. Make your changes and commit them (git commit -m 'Add a feature').
4. Push to the branch (git push origin feature/YourFeature).
5. Open a Pull Request.

License

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