Skip to content

Latest commit

 

History

History
68 lines (43 loc) · 1.21 KB

README.md

File metadata and controls

68 lines (43 loc) · 1.21 KB

Development

Bun is required to build and run the system locally.

Install dependencies:

bun install

Start development server with hot-reload:

bun dev

Database

Docker is required to run the database locally.

Start only the container with the database from docker-compose.yaml:

docker compose up -d --build arrigt-db

Apply migrations:

bun run migrate:dev

Production

Build for production and run:

bun build && bun start

Integration

Linting, formatting, and testing is automatically performed by GitHub Actions on pull requests to the main branch.

  • Run ESLint manually with bun run lint or bun run lint:fix
  • Run Prettier manually with bun run format or bun run format:fix
  • Run Vitest manually with bun run test or bun run test:coverage
  • Run Stryker manually with bun run test:mutation

Deployment

The system can be built for production and deployed using Docker. The docker-compose.yaml runs the following

Build the docker images:

docker compose build

Run the containers:

docker compose up -d

Documents

Specification and documentation resides in the ./docs directory of the project.