50 lines
852 B
Markdown
50 lines
852 B
Markdown
# kuwot-api-js
|
|
|
|
A Node.js REST API built with TypeScript and Express.
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
- Node.js >= 18
|
|
- npm
|
|
|
|
### Installation
|
|
|
|
```sh
|
|
npm install
|
|
```
|
|
|
|
### Configuration
|
|
|
|
1. Copy `.env.example` to `.env` and fill in your secrets:
|
|
```sh
|
|
cp .env.example .env
|
|
```
|
|
2. Set your Unsplash access key and other variables in `.env`.
|
|
3. Download [`quotes.db`](https://app.filen.io/#/d/504e4b51-477d-46c7-828b-67c5c4cab04c%23654b4b345648306a725935564153474743703956385658465571685259755674) and put it in the project root directory.
|
|
|
|
### Running the Server
|
|
|
|
```sh
|
|
npm start
|
|
```
|
|
|
|
### Formatting Code
|
|
|
|
```sh
|
|
npm run format
|
|
```
|
|
|
|
### Recommended VS Code Extensions
|
|
|
|
- ESLint
|
|
- Prettier
|
|
|
|
## Contributing
|
|
|
|
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
|
|
|
## License
|
|
|
|
MIT
|