/sms-management

This is an sms management system

Primary LanguageTypeScriptMIT LicenseMIT

sms-management application

CircleCI

This is a social application that users can send and receive sms

Application Documentation

You can try out the application here

Getting Started

To start development

* Use https://github.com/PaulKariukiRimiru/sms-management.git to clone the repository

* In the project folder run `npm install` or `yarn`

* Add a .env file with `[ DEV_PORT TEST_PORT BASE_URL MONGO_URL_DEV MONGO_URL_TEST ]` variables

Prerequisites

* Ensure you have node and mongodb installed in your machine

* Ensure that you have Git intalled in your machine

Running

To run the app locally

* Run the application using - 'yarn start:dev:watch'

* Access app documentations through http://localhost:3000/api-docs

Running the tests

To run the tests

* Use command `yarn test`

Built With

  • Node + typescript

  • Mongoose ORM

  • Jest

Authors