Quickstart

Get Convocados running on your machine in 5 minutes.

Prerequisites

• Node.js 20 or later
• npm (comes with Node.js)

1. Clone the repository

git clone https://github.com/Cabeda/Convocados.git
cd Convocados

2. Install dependencies

npm install

3. Set up the database

Convocados uses SQLite, so no external database is needed. Create the database and run migrations:

npx prisma migrate dev

4. Configure environment variables

Create a .env file in the project root:

# Required
DATABASE_URL="file:./prisma/dev.db"

# Optional — needed for push notifications
VAPID_PUBLIC_KEY="your-vapid-public-key"
VAPID_PRIVATE_KEY="your-vapid-private-key"

5. Start the dev server

npm run dev

Open http://localhost:4321 in your browser. You should see the "Create a Game" form.

6. Create your first game

1. Enter a game title (e.g. "Tuesday Basketball")
2. Pick a sport and date/time
3. Click Create game
4. Share the generated link with your players

Available scripts

Next steps

• Tutorial — walk through the full game flow
• Self-Hosting — deploy to production
• API Reference — integrate programmatically