Skip to content

Commit 25baf7c

Browse files
Update README.md (#228)
1 parent 29ae40e commit 25baf7c

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,28 +12,29 @@ The official challenges microservice of [Bootstrap Academy](https://bootstrap.ac
1212
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](https://github.com/Bootstrap-Academy/Bootstrap-Academy).
1313

1414
## Development Setup
15-
1. Install the [Rust](https://www.rust-lang.org/) stable toolchain and [just](https://github.com/casey/just).
15+
1. Install the [Rust](https://www.rust-lang.org/) stable toolchain.
1616
2. Clone this repository and `cd` into it.
17-
3. Start a [PostgreSQL](https://www.postgresql.org/) database, for example using [Docker](https://www.docker.com/) or [Podman](https://podman.io/):
17+
3. Install [Just](https://github.com/casey/just) (`cargo install just`) and [Sea-ORM](https://www.sea-ql.org/SeaORM/) (`cargo install sea-orm-cli`)
18+
4. Start a [PostgreSQL](https://www.postgresql.org/) database, for example using [Docker](https://www.docker.com/) or [Podman](https://podman.io/):
1819
```bash
1920
podman run -d --rm \
2021
--name postgres \
2122
-p 127.0.0.1:5432:5432 \
2223
-e POSTGRES_HOST_AUTH_METHOD=trust \
2324
postgres:alpine
2425
```
25-
4. Create the `academy-challenges` database:
26+
5. Create the `academy-challenges` database:
2627
```bash
2728
podman exec postgres \
2829
psql -U postgres \
2930
-c 'create database "academy-challenges"'
3031
```
31-
5. Start a [Redis](https://redis.io/) instance, for example using [Docker](https://www.docker.com/) or [Podman](https://podman.io/):
32+
6. Start a [Redis](https://redis.io/) instance, for example using [Docker](https://www.docker.com/) or [Podman](https://podman.io/):
3233
```bash
3334
podman run -d --rm \
3435
--name redis \
3536
-p 127.0.0.1:6379:6379 \
3637
redis:alpine
3738
```
38-
6. Run `just migrate` to run the database migrations.
39-
7. Run `just run` to start the microservice. You can find the automatically generated swagger documentation on http://localhost:8005/docs.
39+
7. Run `just migrate` to run the database migrations.
40+
8. Run `just run` to start the microservice. You can find the automatically generated swagger documentation on http://localhost:8005/docs.

0 commit comments

Comments
 (0)