Gorbit is a modern social media platform built for speed and simplicity. It features real-time messaging, community forums, media sharing, and a "Glance" story feature.
The project is structured as a monorepo:
frontend: React + Vite with Material Design 3 styling.supabase: Local development configuration and database migrations.backend: Legacy Express/Prisma server (currently being migrated to Supabase).
- Node.js (v18 or higher)
- Docker (required for local Supabase)
- Supabase CLI
-
Clone the repository:
git clone https://github.com/Hotaro26/gorbit.git cd gorbit -
Start the local backend:
cd supabase supabase startThis will pull Docker images and start the database, auth, and storage services. Note the API keys provided in the output.
-
Configure the frontend:
- Navigate to the
frontenddirectory. - Create a
.env.localfile. - Add your Supabase credentials:
VITE_SUPABASE_URL=http://127.0.0.1:54321 VITE_SUPABASE_ANON_KEY=your_anon_key
- Navigate to the
-
Run the frontend:
npm install npm run dev
The app will be available at
http://localhost:5173.
We welcome contributions to Gorbit. To contribute:
- Fork the repository and create a new branch for your feature or bug fix.
- Ensure your code follows the existing architectural patterns.
- Test your changes locally before submitting a pull request.
- Provide a clear description of the changes in your PR.