Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 1.82 KB

README.md

File metadata and controls

68 lines (45 loc) · 1.82 KB
Raw

Habit Reinforcement App

Welcome to the Habit Reinforcement App, a powerful tool designed to help you build and maintain positive habits through a web-based platform. This project is built using the T3 Stack with Next.js and tRPC, offering features like a focus timer, habit tracker, and a daily journal with Markdown support.

🚀 Getting Started

To get your local environment set up and run the application, follow these steps:

  1. Clone the Repository

    git clone https://github.com/yourusername/habit-reinforcement-app.git
cd habit-reinforcement-app

  2. Configure Environment Variables

cp .env.example .env

Copy the .env.example file to .env and fill in the required variables.

  1. Install Dependencies
npm install
  1. Run the Development Server
npm run dev

Access the app by navigating to http://localhost:3000 in your browser.

🎯 Features

  • Focus Timer: Stay focused on tasks with a customizable timer.
  • Habit Tracker: Monitor and track your daily habits.
  • Daily Journal: Record your thoughts and reflections with full Markdown support.
  • Authentication & Authorization

📅 Upcoming Features

  • Goals: Set and track personal or professional goals.
  • Gamification/Reward System

📘 Documentation

This project uses several advanced libraries and frameworks. For more detailed information, refer to the documentation of each:

  • Next.js
  • tRPC
  • Prisma
  • Tailwind CSS
  • NextAuth.js

🌍 Deploying Your App

Ready to deploy? Follow the guides below for popular hosting services:

Vercel
Netlify
Docker

🤝 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.