Skip to content

Commit

Permalink
add make command to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
m4salah committed Jan 5, 2024
1 parent 3a2595b commit c2e2738
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 4 deletions.
6 changes: 5 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,8 @@ run:
test:
@cargo test -- --nocapture
watch-test:
@cargo-watch --watch src --watch Cargo.toml -x "test -- --nocapture"
@cargo-watch --watch src --watch Cargo.toml -x "test -- --nocapture"
docker-run-db:
@docker compose up -d
validate-all:
@cch23-validator --all
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,42 @@ These are my submissions for the [Christmas Code Hunt](https://www.shuttle.rs/cc

I'm using [Axum](https://github.com/tokio-rs/axum).

## First we need to run docker instance hold the postgre db instance

```shell
make docker-run-db
```

## To Run the app

make sure to install [cargo-shuttle](https://docs.shuttle.rs/getting-started/installation)

```shell
cargo shuttle run
make run
```

## To Run Watch

make sure to install [cargo-watch](https://github.com/watchexec/cargo-watch)

```shell
cargo watch -x "shuttle run"
make watch
```

## To Run Tests

```shell
cargo test
make test
```

## To Run Watch on Tests

```shell
make watch-test
```

## To Validate all days

```shell
make validate-all
```

0 comments on commit c2e2738

Please sign in to comment.