An Alert notification service is an application which can receive alerts from certain alerting systems like System_X and System_Y and send these alerts to developers in the form of SMS and emails. Holds basic template for teams of developers to be created and sent messages to. Built with Ruby on Rails.
To run this project locally requires a few prerequisites to be met.
The structure of the project is divided into three different models: team, developer and message. team and developer both house teams and developers that can be created by the user, indexed, edited and deleted if necessary. message houses all the messages sent to the various teams through the trigger_notification route.
After cloning the git project and setting up the prerequisites, run:
bundle installThis will install all the necessary gems needed that can be found in the Gemfile.
After creating a local database using Postgres, run the rails server using this command in the terminal:
rails sNow, all the requests can be run for the app to process.
The available routes and how to access them can be found here in this Postman Documentation
The app is also available to use with Docker and can be used either locally or on a service like Docker Playground. The image for the app can be found here and comes with existing records within the database.
Simply pull:
docker pull fiddler46/sms-rails:<tag>
and then run:
docker run fiddler46/sms-rails:<tag>
and that should start the rails server. The same Postman routes still follow.