Skip to content

dmscn/rereddit-api

Repository files navigation

ReReddit API

(MongoDB, Koa2, React, Node.JS)

Build Status Coverage Status dependencies Status Known Vulnerabilities PRs Welcome

API Documentation

Find here API Documentation

Installation

Before anything you must have make installed.

$ sudo apt install make

Usage

$ make setup

will setup the project, install the images and start the project.

$ make start

starts the container.

$ make stop

stops the container.

$ make exec

enters the container using bash.

Documenting

yarn document

to update the API documentation at doc/