Skip to content

NandanTyagi/streakeraiv1

Repository files navigation

StreakerAi

StreakerAi is a habit-tracking app designed to help users achieve their personal goals through daily habit suggestions. By leveraging the power of AI, StreakerAi provides personalized habit recommendations that align with user aspirations, fostering consistent and meaningful progress.

Features

  • Personalized Habit Suggestions: AI-driven recommendations tailored to user goals.
  • Daily Habit Tracking: Simple interface to track and mark daily habits.
  • Progress Visualization: Visual representation of progress over time.
  • Customizable Goals: Users can set and modify their personal goals.
  • Mobile-Friendly: Designed for a seamless experience on mobile devices.

Motivation

StreakerAi was inspired by the founder's personal journey of transformation. After a decade of unhealthy lifestyle and a challenging relationship, tracking daily habits on a simple calendar led to a remarkable transformation, including significant weight loss and improved well-being. This experience underscored the power of daily habits and inspired the creation of StreakerAi to help others achieve similar transformations.

Installation

To get started with StreakerAi, follow these steps:

  1. Clone the repository:

    git clone https://github.com/NandanTyagi/streakerai.git
  2. Navigate to the project directory:

    cd streakerai
  3. Install dependencies:

    npm install
  4. Set up environment variables:

    • Create a .env file in the root directory and add your environment variables (e.g., OpenAI API key).
    NEXT_PUBLIC_OPENAI_API_KEY=your_openai_api_key
  5. Run the development server:

    npm run dev
  6. Open your browser and navigate to:

    http://localhost:3000
    

Usage

  1. Set Your Goal:

    • Upon logging in, you will be prompted to set your personal goal.
  2. Receive Daily Habit Suggestions:

    • Based on your goal, StreakerAi will suggest five daily habits with measurable targets.
  3. Track Your Habits:

    • Mark off each habit as you complete it every day. Visualize your progress and stay motivated.

Contributing

We welcome contributions from the community! To contribute to StreakerAi, follow these steps:

  1. Fork the repository:

    • Click the "Fork" button at the top of this repository.
  2. Clone your forked repository:

    git clone https://github.com/yourusername/streakerai.git
  3. Create a new branch:

    git checkout -b feature/your-feature-name
  4. Make your changes and commit them:

    git commit -m "Add your commit message here"
  5. Push your changes to your forked repository:

    git push origin feature/your-feature-name
  6. Create a Pull Request:

    • Go to the original repository and click "New Pull Request" to submit your changes for review.

License

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

Contact

For questions or feedback, please contact us at [email protected].


Thank you for using StreakerAi! Let's embark on this journey of personal transformation together.