Skip to content

alertconnect/alert-queue

Repository files navigation

Alert Queue App Logo

This project is cron job service built with Node.js dedicated to handling alerts and sending them to the redis queue.

NPM Version GitHub License

Getting Started

Follow these instructions to set up the project on your local machine for development and testing purposes.

  • Clone the repository to your local machine: git clone https://github.com/prociv-sm/alert-queue.git
  • Install dependencies: yarn install
  • Start the application in development: yarn start:dev
  • Visit http://localhost:3000 in your browser to use the application.

Requirements

Built With

  • Node.js - JavaScript runtime built on Chrome's V8 JavaScript engine.

Contributing

Contributions are welcome! If you want to contribute to this project, please follow these steps:

  • Fork the repository.
  • Create a new branch (git checkout -b feature/your-feature).
  • Make your changes.
  • Commit your changes (git commit -am 'Add new feature').
  • Push to the branch (git push origin feature/your-feature).
  • Create a new Pull Request.

Environment Variables

code description default value
NODE_ENV Node environment development
REDIS_HOST Redis Host localhost
REDIS_PORT Redis Port 6379
REDIS_PASSWORD Redis Password
REDIS_DB Redis Database 0
REDIS_USER Redis User default
UPTIME_URL Uptime URL
UPTIME_KEY Uptime auth key
UPTIME_CONNECT_TOKEN Uptime token

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Author

License

This project is licensed under the MIT License - see the LICENSE file for details