From 1b844c094208be54008cd993ef51d87b808eea24 Mon Sep 17 00:00:00 2001 From: snamiki1212 Date: Mon, 25 Dec 2023 01:10:40 +0900 Subject: [PATCH] fix: update readme --- README.md | 38 ++++++++------------------------------ 1 file changed, 8 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index f976228..d3150f1 100644 --- a/README.md +++ b/README.md @@ -8,49 +8,27 @@ Realworld App using `Rust`, `actix-web`, and `diesel`. ## Getting Started -
- Docker - ```zsh # ready $ sh ./scripts/copy-env.sh -``` -```zsh +# start $ docker compose up -d -``` -```zsh +# healthcheck $ curl http://localhost:8080/api/healthcheck # => OK ``` -
+```sh +# Check app can connect to DB +$ curl http://localhost:8080/api/tags +# => {"tags":[]} -
- Local - -```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 -``` - -
- ## E2E Test Running E2E tests using [POSTMAN scripts](https://github.com/gothinkster/realworld/tree/main/api) on CI