Skip to content

cattode/doc-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

A simple document-based API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published