0 Fork 0

mirror of https://github.com/linux-odyssey/linux-odyssey.git synced 2026-11-05 19:20:12 +08:00

Files

T

wancat 5fd611ab51 docs: improve comments and remove unnecessary lines

- Add a comment about creating a session with a POST request to `/api/v1/sessions`
- Remove the line mentioning `yarn cli` command
- Add a comment about using the `_id` field in the response
- Remove the example usage of `yarn cli`

Signed-off-by: wancat <wancat@wancat.cc>

2023-07-24 15:06:48 +08:00

759 B

Raw Blame History

Linux Odyssey

Requirements

NodeJS
Docker
Yarn

Installation

git clone https://github.com/lancatlin/linux-odyssey.git
cd linux-odyssey
yarn install

Create database

docker compose up -d

Server

Source: server/

yarn server
# Open http://localhost:3000

App

Source: app/

yarn app
# Open http://localhost:5173/

CLI terminal client

Open server first, then create a session by POST /api/v1/sessions

curl -X 'POST' \
  'http://localhost:3000/api/v1/sessions' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "quest_id": "helloworld"
}'

Then use the _id field in response

yarn cli [_id]
# example
yarn cli 64be226a39c0043cd1cdf7c2

759 B Raw Blame History