Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 1.65 KB

README.md

File metadata and controls

59 lines (41 loc) · 1.65 KB

STOIRIC

A minimalist daily journaling app that helps you track your goals, reflect on your day, and measure your personal growth.

Features

  • 📝 Daily Goal Setting: Set and track your daily tasks and mark important priorities
  • 🤖 Guided Reflection: End your day with reflection session that feels like chatting with someone about your day.
  • 📊 Daily Scoring: Get a daily score based on task completion and self-ratings
  • 📅 Visual Progress: Track your journey with a heat map calendar
  • 🔒 Privacy-Focused: Your data stays local in your browser
  • 💾 Data Export: Download your journal entries anytime

How It Works

  1. Start Your Day: Set your goals and tasks for the day
  2. Track Progress: Mark tasks as complete as you go
  3. Evening Reflection: Answer reflection questions about your day
  4. Rate Your Day: Score different aspects of your day
  5. Review Progress: View your daily score and track improvements

Technology Stack

  • React
  • Vite
  • TailwindCSS for styling
  • Shadcn/ui for component library
  • Firebase Authentication

Getting Started

# Clone the repository
git clone https://github.com/aditya-borse/stoiric.git

# Navigate to project directory
cd stoiric

# Install dependencies
npm install

# Start development server
npm run dev

IMPORTANT: Make sure to create a firebase project refer to the .env.example to setup the environment variables

Contributing

Contributions are welcome! Feel free to:

  • Report bugs
  • Suggest new features
  • Submit pull requests
  • Improve documentation

License

This project is open source and available under the MIT License.