https://github.com/antoneekstrom/arrigt2

https://github.com/antoneekstrom/arrigt2

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/antoneekstrom/arrigt2
• Owner: antoneekstrom
• Created: 2023-11-20T13:43:05.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-04T16:23:55.000Z (9 months ago)
• Last Synced: 2024-04-04T17:36:55.843Z (9 months ago)
• Language: TypeScript
• Size: 1.19 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Development

Bun is required to build and run the system locally.

Install dependencies:

```shell

bun install

```

Start development server with hot-reload:

```shell

bun dev

```

### Database

Docker is required to run the database locally.

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

```shell

docker compose up -d --build arrigt-db

```

Apply migrations:

```shell

bun run migrate:dev

```

## Production

Build for production and run:

```shell

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:

```shell

docker compose build

```

Run the containers:

```shell

docker compose up -d

```

## Documents

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