diff --git a/developement-setup.md b/development-setup.md similarity index 95% rename from developement-setup.md rename to development-setup.md index 1bb00f18..4743f2a9 100644 --- a/developement-setup.md +++ b/development-setup.md @@ -1,54 +1,54 @@ -# Setup developement project - -## Installing - -complete this steps from [README - Installing](README.md#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` +# Setup developement project + +## Installing + +complete this steps from [README - Installing](README.md#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`