/doc-api

A simple document-based API

Primary LanguageTypeScript

Document API

A simple document-based API

Installing

Make sure Node.JS is installed

Clone the repo

git clone https://github.com/cattode/doc-api.git

Install dependencies

npm install

Start the server

npm start

Usage

The configuration file is in doc-api/src/config.ts. By default, the API runs on http://localhost:3000/.

An API usage guide can be found on the Wiki.

Running the tests

npm test

License

This project is unlicensed.