Skip to content

amiralies/metalarchives-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MetalArchives RESTful API

RESTful API for metal-archives.com written in NodeJS, express.

How to run

  1. Make sure you have nodejs, mongodb and git installed.

  2. Clone the repo:

git clone https://github.com/amiralies/metalarchives-api.git
  1. Install dependencies :
cd metalarchives-api 
npm install
  1. Catch database :
npm run catchDB
  1. Start API :
npm start
  1. Done.

Docs

To generate docs follow these steps:

  1. Install apidoc :
npm install -g apidoc
  1. cd to /apidoc folder in repo.

  2. Serve files with your desired http server.

  3. Done.