The SMS management application is a project inspired by my LMS Outputs for Andela for my D2 Assessments. The aim is a back-end javascript application that implements a simple way to send and receive SMS messages between contacts on the application
- Getting Started
- Technology Stack
- Installation
- Usage
- Testing
- API Endpoints
- Questions
- Support or Contribution
This is a backend javascript application built with Node JS using Express framework. The application runs with Redis server and Express Session for security and validation of users.
Server Side
- NodeJS
- Express FrameWork
-
Install Node JS.
-
Clone the repository here
-
[cd] into the root of the project directory.
-
Run
yarn install
on the terminal to install project dependecies -
Create a
.env
file in the root directory of the application. Example of the content of a .env file is shown in the .env.sample -
Start the application: Different Build Environments
Production
yarn build
yarn drop-migrations
yarn migrations
yarn start:prod
Development
yarn clean_start:dev
Sever side tests - Run yarn test
on the terminal while within the project root directory.
Server side testing is achieved through use of chai-http
, mocha
and chai
packages. chai-http
is used to make requests to the api and mocha
is the testing framework and chai
is the exception library. They will both be installed when you run yarn install
and the tests will run when you run yarn test
.
Please view API Documentation here
For more details contact benny.ogidan@andela.com
For any suggestions or contributions or issues please do raise them or email me. For Contributions, Please clone the repo and implement a PR I would appreciate it