READIT NodeJs/Express application

Description

3-5 sentences describing the code and what it's purpose is

Documentation

List of endpoints exposed by the service

Getting Started

Get the latest version

https://github.com/abayo-luc/readIt.git

Change directory

cd readit

Update the environments variables in sample.env file and rename it to '.env'

mv sample.env .env

Install the dependencies

yarn

Start the application

yarn server

Testing

yarn test

Contribute

Any instructions needed to help others contribute to this repository

Deployment

Step by step instructions so that the developer can understand how code gets updated