https://github.com/EddieGustafsson/RestAPI

RestAPI based on TP's web services (Wiki, Blog and Calendar)
https://github.com/EddieGustafsson/RestAPI

blog calendar mongodb nodejs rest-api web-services wiki

Last synced: 5 days ago
JSON representation

RestAPI based on TP's web services (Wiki, Blog and Calendar)

• Host: GitHub
• URL: https://github.com/EddieGustafsson/RestAPI
• Owner: EddieGustafsson
• Archived: true
• Created: 2019-10-26T14:19:14.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-02-10T12:42:18.000Z (over 2 years ago)
• Last Synced: 2024-08-01T12:31:05.626Z (3 months ago)
• Topics: blog, calendar, mongodb, nodejs, rest-api, web-services, wiki
• Language: JavaScript
• Homepage:
• Size: 3.49 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.MD
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-starred - EddieGustafsson/RestAPI - RestAPI based on TP's web services (Wiki, Blog and Calendar) (rest-api)

README

        

# RestAPI

## Introduction

This is a [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) API based on [TP](https://github.com/Shrimpis/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](https://github.com/EddieGustafsson/RestAPI/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](https://www.mongodb.com/download-center).

### 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:

```json

{

    "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```