SMS managment API system that ensure that people can send or receive messages.
- NodeJS
- ExpressJS
- pg
- Mocha(Testing)
NB: This app does not use any ORM
- person sending sms
- person receiving sms
- message of sms
- sms status
- name of person
- phone number of person
- All sms sent by a Contact should be linked to them
- All sms sent to a Contact should be linked to them
- Deleting a contact removes the messages they sent and references to messages they received.
- Clone:
git clone https://github.com/me-x-mi/sms-management-application-api.git
- Change directory:
cd sms-management-application-api
- Install dependancies:
npm install
- Set up
.env
file using the example.env.example
- Create tables
npm run create
- Run development:
npm run start:dev
- Documentation served on:
http://localhost:8000/api-documentation/
- Run tests:
npm test
NB: To drop any tables previous created use npm run drop
To run production version npm run start:prod
Endpoint | Functionality | HTTP method |
---|---|---|
/contacts | Add a contact | POST |
/contacts | Get all contacts | GET |
/contacts/:id | Delete/remove a contact | DELETE |
/sms | Add a sms | POST |
/sms | Get all sms | GET |
Ezrqn Kemboi