Contributing

Development setup, project structure, and contribution guidelines.

Getting started

git clone https://github.com/Cabeda/Convocados.git
cd Convocados
npm ci
npx prisma generate
npx prisma db push        # create local SQLite DB
npm run dev                # start dev server on http://localhost:4321

Project structure

Convocados/
├── prisma/
│   └── schema.prisma       # Database schema
├── public/                 # Static assets
├── src/
│   ├── components/         # React components (MUI)
│   ├── layouts/            # Astro layouts (DocsLayout, etc.)
│   ├── lib/                # Server utilities (db, webhook, push, i18n)
│   ├── pages/
│   │   ├── api/            # API routes (Astro endpoints)
│   │   ├── docs/           # Documentation pages
│   │   ├── events/         # Event UI pages
│   │   └── index.astro     # Home page
│   └── test/               # Vitest test files
├── Dockerfile
├── fly.toml
└── package.json

Tech stack

Layer	Technology
Framework	Astro 5 (SSR with Node adapter)
UI	React 19 + MUI 6
Database	SQLite via Prisma 6
Testing	Vitest + Supertest
Deployment	Docker on Fly.io

Scripts

Command	Description
`npm run dev`	Start Astro dev server
`npm run build`	Production build
`npm run test`	Run tests with Vitest
`npm run typecheck`	TypeScript type checking
`npm run db:generate`	Regenerate Prisma client
`npm run db:migrate`	Create and apply migrations
`npm run db:studio`	Open Prisma Studio GUI

Running tests

npm run test

Tests use Vitest with Supertest for API endpoint testing. The test suite uses an in-memory SQLite database, so no external setup is needed.

Code style

TypeScript strict mode
Astro pages use .astro files; interactive components use React .tsx
API routes export named HTTP method handlers (GET, POST, PATCH, DELETE)
Server-only code lives in *.server.ts files

Making changes

Fork the repository and create a feature branch
Make your changes (test-first: write a failing test, then implement)
Run npm run typecheck and npm run test to verify
Open a pull request against main
Sign the Contributor License Agreementwhen the CLA bot asks on your first PR (comment “I have read the CLA Document and I hereby sign the CLA”)

Database changes: If you modify prisma/schema.prisma, run npm run db:migrate to create a migration file, then commit it with your PR.

CLA: First-time contributors must sign the CLA before their pull request can be merged — it lets the maintainer relicense or sell commercial licenses over contributed code under FSL-1.1-ALv2. Trademark use of the Convocados name and logo is covered separately inTRADEMARK.md.