SMS Management API is an api for managing Contacts and Messages. It allows the following operations:
- Creation of Contacts (with unique mobile numbers)
- Creation of Messages which are linked to two Contacts: Sender and Receiver of the message
- Deletion of Contacts - This deletes all messages sent by or received by the contact.
- Updating Contact and Messages details.
- And much more, if not already implemented, surely are in the works
To be able to run this application locally, the following are required:
- Node.JS
- Node Package Manager (npm)
- Postgres DB service
This can be easily installed locally through these steps:
- Clone the repository locally
- Create a .env file in the root repository with the necessary environment variables as in the .env.example file
- Create the Postgres databases specified in the .env DB URLs
- Run
npm installto install dependent Node packages - Run
npm startto start the server
To interact with this service, you should use the API documentation available at Swagger Hub
This application can be tested locally by running npm test
- Fork this repository to your GitHub account
- Clone the forked repository
- Create your feature branch
- Commit your changes
- Push to the remote branch
- Open a Pull Request
- Setup Version Control System
- Setup CI/CD using Travis for builds and Coveralls for coverage reporting
- Add Integration tests
- Implement Data Layer - Models, Migrations..
- Implement Routes, Controllers, and API server
- Implement Pagination through endpoints
- Implement Searching through endpoints
- Setup code style linting checks
- Add UI
sms-management-api is implemented using a number of technologies, these include: