README.md

Bootstrap Academy Challenges Microservice

The official challenges microservice of Bootstrap Academy.

If you would like to submit a bug report or feature request, or are looking for general information about the project or the publicly available instances, please refer to the Bootstrap-Academy repository.

Development Setup

1. Install the Rust stable toolchain.
2. Clone this repository and cd into it.
3. Install Just (cargo install just) and Sea-ORM (cargo install sea-orm-cli)
4. Start a PostgreSQL database, for example using Docker or Podman:

   podman run -d --rm \
       --name postgres \
       -p 127.0.0.1:5432:5432 \
       -e POSTGRES_HOST_AUTH_METHOD=trust \
       postgres:alpine

5. Create the academy-challenges database:

   podman exec postgres \
       psql -U postgres \
       -c 'create database "academy-challenges"'

6. Start a Redis instance, for example using Docker or Podman:

   podman run -d --rm \
       --name redis \
       -p 127.0.0.1:6379:6379 \
       redis:alpine

7. Run just migrate to run the database migrations.
8. Run just run to start the microservice. You can find the automatically generated swagger documentation on http://localhost:8005/docs.