osk-backend
Backend for the official website of Open Source Kigali
File Explorer
- bug_report.md
- feature_request.md
- ci.yml
- keep-alive.yml
- PULL_REQUEST_TEMPLATE.md
- pre-commit
- pre-push
- openapi.yaml
- migration.sql
- migration.sql
- migration.sql
- migration.sql
- migration.sql
- migration.sql
- migration.sql
- migration.sql
- migration.sql
- migration.sql
- migration.sql
- migration_lock.toml
- schema.prisma
- cloudinary.ts
- env.ts
- prisma.ts
- contributor.controller.test.ts
- contributor.controller.ts
- contributors.controller.ts
- event.controller.test.ts
- event.controller.ts
- health.controller.ts
- member.controller.test.ts
- member.controller.ts
- partner-application.controller.ts
- partner.controllers.ts
- project.controller.test.ts
- project.controller.ts
- review.controller.ts
- stats.controller.test.ts
- stats.controller.ts
- auth.middleware.test.ts
- auth.middleware.ts
- error.middleware.test.ts
- error.middleware.ts
- not-found.middleware.test.ts
- not-found.middleware.ts
- rate-limit.middleware.test.ts
- rate-limit.middleware.ts
- upload.middleware.ts
- contributors.routes.ts
- event.routes.ts
- health.routes.ts
- index.ts
- member.routes.ts
- partner-application.routes.ts
- partner.routes.ts
- project.routes.ts
- review.routes.ts
- stats.routes.ts
- event.schema.ts
- member.schema.ts
- partner-application.schema.ts
- partner.schema.ts
- project.schema.ts
- contributor.service.ts
- contributors.service.ts
- event.service.ts
- github.service.ts
- member.service.test.ts
- member.service.ts
- partner-application.service.test.ts
- partner-application.service.ts
- partner.service.ts
- project.service.test.ts
- project.service.ts
- review.service.test.ts
- review.service.ts
- stats.service.test.ts
- stats.service.ts
- cloudinary-upload.ts
- response.test.ts
- response.ts
- trim-strings.ts
- validation.ts
- app.ts
- server.ts
- .env.example
- .gitignore
- .prettierignore
- .prettierrc
- banner.png
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- contributors.json
- CONTRIBUTORS.md
- docker-compose.yml
- eslint.config.mjs
- LICENSE
- package-lock.json
- package.json
- pnpm-lock.yaml
- pnpm-workspace.yaml
- prisma.config.ts
- README.md
- SECURITY.md
- tsconfig.json
- vitest.config.ts
- vitest.setup.ts
# Use via CDN
jsDelivrjsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.
Command Glossary
Commands referenced in this DOCs, explained below.
docker compose down
View Details ▼
docker compose down
Stop and remove containers, networks, images, and volumes created by `docker compose up`.
docker compose down
Stop and remove all containers and networks:
docker compose down --rmi all
Stop and remove containers, networks, and all images used by services:
docker compose down --rmi local
Stop and remove containers, networks, and only images without a custom tag:
docker compose up
View Details ▼
docker compose up
Start and run Docker services defined in a Compose file.
docker compose up
Start all services defined in the docker-compose file:
docker compose up {{[-d|--detach]}}
Start services in the background (detached mode):
docker compose up --build
Start services and rebuild images before starting:
npm install
View Details ▼
npm install
Install Node packages.
npm {{[i|install]}}
Install dependencies listed in `package.json`:
npm {{[i|install]}} {{package_name}}@{{version}}
Download a specific version of a package and add it to the list of dependencies in `package.json`:
npm {{[i|install]}} {{package_name}} {{[-D|--save-dev]}}
Download the latest version of a package and add it to the list of dev dependencies in `package.json`:
npm run
View Details ▼
npm run
Run a script.
npm run
List available scripts:
npm run {{script_name}}
Run a script:
npm run {{script_name}} -- {{argument}} {{--option}}
Pass arguments to a script:
npm start
View Details ▼
npm start
This command is an alias of `npm run start`.
tldr npm run
View documentation for the original command:
npm test
View Details ▼
npm test
This command is an alias of `npm run test`.
tldr npm run
View documentation for the original command:
npx
View Details ▼
npx
This command is an alias of `npm exec`.
tldr npm exec
View documentation for the original command: