Skip to content

Latest commit

 

History

History
71 lines (55 loc) · 1.81 KB

TUTORIAL_TECH_EN.md

File metadata and controls

71 lines (55 loc) · 1.81 KB

🇺🇸 Technical Guide - Mattioli.OS

Complete guide for developers or anyone wishing to self-host the application.

📋 Requirements

  • Node.js (Version 18 or higher)
  • NPM or Bun
  • A Supabase account (Free tier is sufficient)

🛠 Local Installation

1. Clone the Repository

Download the source code to your machine.

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

2. Install Dependencies

Install all necessary libraries.

npm install
# or
bun install

3. Supabase Configuration (Database)

This app uses Supabase for the database and authentication.

  1. Create a new project on Supabase.com.
  2. Go to Project Settings -> API.
  3. Copy Project URL and anon public key.
  4. Create a .env file in the project root and paste the values:
VITE_SUPABASE_URL=your_supabase_url
VITE_SUPABASE_ANON_KEY=your_anon_key

Important

Database Setup: You will find a schema.sql file in the project root.

  1. Open the SQL Editor in your Supabase project.
  2. Copy and paste the entire content of schema.sql.
  3. Run the script to create all necessary tables and security policies.

4. Start the App

npm run dev

The app will be available at http://localhost:5173.

🚢 Build & Deploy

To create an optimized production build:

npm run build

The dist folder will contain the static files ready to be uploaded to Vercel, Netlify, or your personal web server.

🗄 Project Structure

  • /src/components: Reusable UI components.
  • /src/hooks: Custom business logic (e.g., useHabits).
  • /src/lib/supabase.ts: Database client configuration.
  • /src/pages: Main application pages.

For architecture details, see TECHNICAL_DEEP_DIVE.md.