loicemeyo / text_me_will_you Goto Github PK

It enables users to send and receive text messages. A Nodejs API built using the express framework and Postgres as the data store.

Installing locally

• clone the repo
• checkout to develop branch
• install postgres and create database both for development and testing
• Use yarn install to install to install dependencies
• Run database migrations yarn db:migrate
• start the application with yarn start or yarn start:dev
• Use yarn test to run the tests

API features

• creating contacts
• sending and recieving sms

Endpoints exposed by the API

Endpoint payload

• POST /contacts

{
  "name": "name",
  "phone": "phone number"
}

• POST /sms

{
  "message": "message to send",
  "sender": "the phone number of the sender",
  "receiver": "the phone number of message reciepient"
}

Note Both the sender and receiver contacts have to be existing for successful message sending