SMS-Management-Application-API

Introduction

Available Endpoints

The documentation for the SMS Management API can be found here SMS API

Dependencies

To install the SMS Management API, you will need the following:

• Node
• PostgreSQL
• Other dependencies required are listed in the package.json file. Use npm install on the command line
• Environment variables are defined in a .env file. You can find a .sample.env file in the repository root to guide you on setting up your .env file.

Installation

The steps outline will provide a walkthrough on how to install the app on your local machine

• Clone this repository
• From the terminal, change directory to the sms-management-application folder
• Ensure that you are on the develop branch. If on any other branch, run git checkout develop on the terminal.
• Run yarn install from your terminal in your project directory to install all dependencies
• Then run the app with the command npm start

Usage

To test out the endpoints, follow the following steps

• Once all dependencies have beeen installed, run npm start on your terminal to test the endpoints The app link for the hosted app on heroku is "https://sms-management-api-raphael.herokuapp.com".

Limitations

• No form of authentication is iimplemented

The DEV Team

• Raphael Etim