Skip to content

Pnlpz/crelo

Repository files navigation

Crelo

A modern web application built with React, TypeScript, and Supabase.

🚀 Features

  • React 18 with TypeScript
  • Supabase for authentication and database
  • Tailwind CSS for styling
  • React Router for navigation
  • Lucide React for icons
  • ESLint for code quality
  • Vite for fast development and building

🛠️ Tech Stack

  • Frontend Framework: React 18
  • Language: TypeScript
  • Styling: Tailwind CSS
  • Authentication & Database: Supabase
  • Routing: React Router
  • Build Tool: Vite
  • Package Manager: npm

📋 Prerequisites

  • Node.js (latest LTS version recommended)
  • npm (comes with Node.js)
  • Supabase account and project

🚀 Getting Started

  1. Clone the repository:

    git clone [your-repository-url]
    cd crelo
  2. Install dependencies:

    npm install
  3. Create a .env file in the root directory and add your Supabase credentials:

    VITE_SUPABASE_URL=your_supabase_url
    VITE_SUPABASE_ANON_KEY=your_supabase_anon_key
    
  4. Start the development server:

    npm run dev
  5. Open http://localhost:5173 in your browser.

📦 Available Scripts

  • npm run dev - Start the development server
  • npm run build - Build the application for production
  • npm run preview - Preview the production build locally
  • npm run lint - Run ESLint to check code quality

📁 Project Structure

crelo/
├── src/
│   ├── components/     # React components
│   ├── lib/           # Utility functions and configurations
│   ├── types/         # TypeScript type definitions
│   ├── App.tsx        # Main application component
│   ├── main.tsx       # Application entry point
│   └── index.css      # Global styles
├── public/            # Static assets
├── supabase/         # Supabase configuration and migrations
└── ...config files

🔧 Configuration

  • vite.config.ts - Vite configuration
  • tailwind.config.js - Tailwind CSS configuration
  • tsconfig.json - TypeScript configuration
  • eslint.config.js - ESLint configuration

🤝 Contributing

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

📝 License

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

About

Created with StackBlitz ⚡️

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published