Skip to content

Commit

Permalink
fix: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
snamiki1212 committed Dec 24, 2023
1 parent 2c4d32b commit 1b844c0
Showing 1 changed file with 8 additions and 30 deletions.
38 changes: 8 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,49 +8,27 @@ Realworld App using `Rust`, `actix-web`, and `diesel`.

## Getting Started

<details>
<summary>Docker</summary>

```zsh
# ready
$ sh ./scripts/copy-env.sh
```

```zsh
# start
$ docker compose up -d
```

```zsh
# healthcheck
$ curl http://localhost:8080/api/healthcheck
# => OK
```

</details>
```sh
# Check app can connect to DB
$ curl http://localhost:8080/api/tags
# => {"tags":[]}

<details>
<summary>Local</summary>

```zsh
# ready
$ sh ./scripts/copy-env.sh
# Check app can insert data into DB
curl -X POST http://localhost:8080/api/users -d '{"user": {"email": "a@a.a", "username": "a", "password": "a" }}' -H "Content-Type: application/json"
```

```zsh
# start postgres
$ brew services start postgresql

# start app
$ diesel setup
$ cargo run
```

```zsh
$ curl http://localhost:8080/api/healthcheck
# => OK
```

</details>

## E2E Test

Running E2E tests using [POSTMAN scripts](https://github.com/gothinkster/realworld/tree/main/api) on CI
Expand Down

0 comments on commit 1b844c0

Please sign in to comment.