logto/packages/core/README.md

# @logto/core

The core backend service.

## Get started

Copy proper `.env` to project root. (TBD: design the config process)

```bash
pnpm i && pnpm dev
```

## OpenAPI documentation

OpenAPI (Swagger) json is available on `http(s)://your-domain/api/swagger.json`. If you are running locally, the default URL will be `http://localhost:3001/api/swagger.json`. Consume it in the way you like.

### Using ReDoc

The doc website can be served by [redoc-cli](https://github.com/Redocly/redoc/blob/master/cli/README.md) in an extremely easy way:

```bash
npx redoc-cli serve http://localhost:3001/api/swagger.json
```

### Using Swagger editor

Copy the API output and paste it in the [Swagger Editor](https://editor.swagger.io/).
chore: update README 2021-07-25 22:44:07 +08:00			`# @logto/core`
Initial commit 2021-06-06 18:30:37 +08:00
chore: update README 2021-07-25 22:44:07 +08:00			`The core backend service.`
Initial commit 2021-06-06 18:30:37 +08:00
chore: use sentence case 2023-10-25 14:01:49 +08:00			`## Get started`
Initial commit 2021-06-06 18:30:37 +08:00
docs: remove out-dated env sample 2021-07-09 23:27:46 +08:00			Copy proper `.env` to project root. (TBD: design the config process)
Update README.md 2021-06-29 23:04:20 +08:00
Initial commit 2021-06-06 18:30:37 +08:00			```bash
chore: yarn -> pnpm 2021-07-29 17:46:28 +08:00			`pnpm i && pnpm dev`
Initial commit 2021-06-06 18:30:37 +08:00			```

chore: use sentence case 2023-10-25 14:01:49 +08:00			`## OpenAPI documentation`
Initial commit 2021-06-06 18:30:37 +08:00
feat: auto-gen api doc 2021-07-23 23:10:54 +08:00			OpenAPI (Swagger) json is available on `http(s)://your-domain/api/swagger.json`. If you are running locally, the default URL will be `http://localhost:3001/api/swagger.json`. Consume it in the way you like.

			`### Using ReDoc`

			`The doc website can be served by [redoc-cli](https://github.com/Redocly/redoc/blob/master/cli/README.md) in an extremely easy way:`

			```bash
			`npx redoc-cli serve http://localhost:3001/api/swagger.json`
			```

chore: use sentence case 2023-10-25 14:01:49 +08:00			`### Using Swagger editor`
feat: auto-gen api doc 2021-07-23 23:10:54 +08:00
			`Copy the API output and paste it in the [Swagger Editor](https://editor.swagger.io/).`