wanhose/cookie-dialog-monster
wanhose/cookie-dialog-monster
2
5
Fork 0
Code Issues 304 Pull Requests Releases 18 Wiki Activity

docs(api): improve readme

Browse Source
This commit is contained in:
wanhose 2024-05-06 20:07:42 +02:00
parent e0439a8572
commit 335a185075
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
packages/api/docs/README.md
View File

@ -1,5 +1,31 @@
# Cookie Monster Dialog API # Cookie Monster Dialog API
## Installation
Make sure you have [Node.js](https://nodejs.org/) (version 20.x) and [Yarn](https://yarnpkg.com/) installed.
```bash
yarn install
```
## Scripts
### `yarn build`
Removes the build directory and compiles TypeScript files.
### `yarn dev`
Starts the server in development mode with nodemon.
### `yarn lint`
Lints the codebase using ESLint.
### `yarn start`
Starts the API server instance in production mode.
## Contributing ## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.