nomadxd/commhawk

Real time emergency alerting and incident reporting system

Commhawk

🛰 Real time emergency alerting and incident reporting system 🛰️
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Commhawk is an emergency alerting and incident reporting system which is ideal for government institutes/organisations that are in the domain of disaster management.

The repository contain the backend code for the project Commhawk. The project comprises of 2 modules which are independently implemented for emergency alerting and incident reporting. The project is designed and implemented according to the microservices architecture.

Built With

• NodeJS
• Docker
• RethinkDB
• Postgresql
• Python
• Firebase
• AWS
• Socket.io

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• docker
• docker-compose

Installing Docker on Ubuntu 18.04 LTS

sudo apt update
sudo apt install apt-transport-https ca-certificates curl software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu bionic stable"
sudo apt update
apt-cache policy docker-ce
sudo apt install docker-ce
sudo systemctl status docker

Installing Docker-compose on Ubuntu 18.04 LTS

sudo curl -L https://github.com/docker/compose/releases/download/1.21.2/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
docker-compose --version

Installation

1. Clone the repo

git clone https://github.com/NomadXD/commhawk.git
cd commhawk

2. Build the project with docker-compose

docker-compose build

3. Start the services with docker-compose

docker-compose up

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Lahiru Udayanga - [email protected]

Acknowledgements

• Dr. Dulani Meedeniya Senior Lecturer, Department of Computer Science and Engineering, University of Moratuwa, Sri Lanka
• Mr. Sachin Kahawala, Mentor, Department of Computer Science and Engineering, University of Moratuwa, Sri Lanka