bad5ect0r / WebHawk

An asset monitoring web app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

WebHawk

An asset monitoring web application. A fun project of mine just to polish up on my Python/Django skills.

How to

Ensure you have a virtual Python environment first.

$ python3 -m venv venv
$ source venv/bin/activate

Then you need to install all the requirements.

$ pip3 install -r requirements.txt

Next, you need to create a .env file. To do this, you can copy the .env.example file.

If you're using Pushover for notifications, you would need to add your secret values for that too. Remember to uncomment it. At the moment you need to use Pushover since we don't have any other method for enabling notifications. In the future we will make this a feature.

Finally, you need to run migrations by doing

$ python3 manage.py migrate

You should also add a new superuser:

$ python3 manage.py createsuperuser

To run the app, you need to do

$ python3 manage.py runserver

Let me know if you have any issues.

Docker

The Dockerfile and docker-compose.yml file is designed to run the Django app in production. Make sure you edit the .env file where appropriate.

Once you've done all that you just need to run the following:

$ docker-compose up -d --build

About

An asset monitoring web app


Languages

Language:JavaScript 45.3%Language:Python 29.1%Language:CSS 24.7%Language:HTML 0.8%Language:Shell 0.1%Language:Dockerfile 0.1%