Kremlin Rest API

API for our i-Semester project

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Node.js
LoopBack

npm install -g loopback-cli

This project on branch develop

git clone https://github.com/MoscuLabs/kremlin-api.git

cd kremlin-api
git checkout develop

Installing

First install all the dependencies

npm install

Update file server/datasources.json with the url keys for the database.

To start running the server

node .

Look for http://localhost:3000/explorer/ in your browser.

Deployment

We will deploy the REST API server into Heroku using git.

You can check the public documentation explorer in kremlin-api.heroku

Built With

LoopBack - The Node.js API Framework
EsLint - The pluggable linting utility for JavaScript and JSX
Heroku - Cloud Application Platmform
Postman - The API Testing Framework

Authors

See the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

Our teacher Zabdiel Zaramillo

MoscuLabs / kremlin-api