RestAPI

Introduction

This is a RESTful API based on TP's web services, which is a backend for a wiki, blog and calender.

To see the current documentation for this API then see the wiki, please remember that this API still is under development, therefore some documentation and functions are missing or deprecated.

Installation

1. MongoDB Cluster

This API uses a mongoDB cluster, therefore you need to create your own mongoDB localy or use a mongoDB atlas cluster.

2. Nodemon.json

In order to test this RestAPI you have to create a nodemon.json file in the root directory with the following contents:

{
    "env":{
        "MONGO_ATLAS_USERNAME": "YOUR USERNAME",
        "MONGO_ATLAS_PWD": "YOUR PASSWORD",
        "HOST": "localhost",
        "PORT": "8080",
        "JWT_KEY": "YOUR KEY"
    }
}

3. Install dependencies

Run the the following command in a command line: npm install

4. Start the API

To start the API type this in a command line: npm start