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

Scripts

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

1. Fork the repository and create a feature branch
2. Make your changes
3. Run npm run typecheck and npm run test to verify
4. Open a pull request against main