Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.serial.okos.com/llms.txt

Use this file to discover all available pages before exploring further.

The easiest way to get started is to clone the Serial mono repo and run the frontend locally. To do so:
  1. Clone the repository: 
    git clone https://github.com/your-account/serial.git
cd serial
  2. Install dependencies: 
    cd frontend
npm install
  3. Run the frontend locally connected to the staging database: 
    npm run staging
The frontend will start on the default local server address: http://localhost:5173 Note that there are three different npm scripts for running the frontend, each corresponding to a different environment:
  • npm run development: Uses the .env.development file and connects to local or development services.
  • npm run staging: Uses the .env.staging file and connects to the staging environment services.
  • npm run production: Uses the .env.production file and connects to the production environment services.
When developing new features or fixing bugs, it’s recommended to use npm run development with a local Supabase instance and Zuplo gateway. This allows for isolated testing without affecting the staging or production environments.