fiatcode/kuwot-api
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
REST API for Kuwot app
13 commits 1 branch 0 tags 73 KiB
Find a file
fiatcode d634c3089d update compose file
2026-03-12 02:36:18 +01:00
.vscode implement auth 2025-10-18 23:33:22 +07:00
public add privacy policy 2025-10-23 08:02:49 +07:00
src add privacy policy 2025-10-23 08:02:49 +07:00
.dockerignore add docker 2025-10-20 08:18:02 +07:00
.env.example add docker 2025-10-20 08:18:02 +07:00
.gitignore replace auth with rate limiter 2025-10-19 10:52:36 +07:00
.prettierignore initial commit 2025-10-18 10:37:22 +07:00
.prettierrc initial commit 2025-10-18 10:37:22 +07:00
compose.yml update compose file 2026-03-12 02:36:18 +01:00
Dockerfile add docker 2025-10-20 08:18:02 +07:00
LICENSE Create LICENSE 2025-10-19 10:58:44 +07:00
package-lock.json replace auth with rate limiter 2025-10-19 10:52:36 +07:00
package.json replace auth with rate limiter 2025-10-19 10:52:36 +07:00
README.md add docker 2025-10-20 08:18:02 +07:00
testLoad.js add additional comments 2025-10-20 10:58:27 +07:00
testRateLimit.js add additional comments 2025-10-20 10:58:27 +07:00
tsconfig.json implement auth 2025-10-18 23:33:22 +07:00

README.md

kuwot-api-js

A Node.js REST API built with TypeScript and Express.

Getting Started

Prerequisites

  • Node.js >= 18
  • npm

Installation

npm install

Configuration

  1. Copy .env.example to .env and fill in your secrets: 
    cp .env.example .env
  2. Set your Unsplash access key and other variables in .env.
  3. Download quotes.db and put it in the project root directory.

Running the Server

npm start

Formatting Code

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