36 lines
655 B
Markdown
36 lines
655 B
Markdown
# Cookie Dialog Monster 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
|
|
|
|
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
|
|
|
## License
|
|
|
|
[MIT](https://choosealicense.com/licenses/mit/)
|