From 4656bbf8723f9158bf1ada011564c0502580fb69 Mon Sep 17 00:00:00 2001 From: RubenPX Date: Mon, 4 Apr 2022 12:35:52 +0200 Subject: [PATCH] add developement setup guide --- developement-setup.md | 55 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 developement-setup.md diff --git a/developement-setup.md b/developement-setup.md new file mode 100644 index 00000000..d2684fbf --- /dev/null +++ b/developement-setup.md @@ -0,0 +1,55 @@ +# Setup developement project + +## Installing + +complete this steps from readme +- #installing + +## Setup project + +Create a PostgreSQL database called devicehub by running [create-db](examples/create-db.sh): + +- Start postgresDB +- `bash examples/create-db.sh devicehub dhub, and password ereuse.` +- `cp examples/env.example .env` + +Create a secretkey and add into `.env` + +```bash +echo "SECRET_KEY=$(python3 -c 'import secrets; print(secrets.token_hex())')" >> .env +``` + +Using the dh tool for set up with one or multiple inventories. Create the tables in the database by executing: + +```bash +export dhi=dbtest; dh inv add --common --name dbtest +``` + +Create a demo table + +```bash +export dhi=dbtest; dh dummy +``` + +copy `examples/app.py` to project directory: +```bash +copy examples/app.py . +``` + +## Run project + +Run the app + +```bash +export FLASK_APP=app.py; export FLASK_ENV=development; flask run --debugger +``` + +Finally login into `localhost:5000/login/` + +- User: user@dhub.com +- Pass: 1234 + +## Troubleshooting + +- If when execute dh command it thows an error, install this dependencies in your distro + - `sudo apt install python3-pip python3-cffi python3-brotli libpango-1.0-0 libpangoft2-1.0-0`