Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
GISRedeDev committed Jan 26, 2025
1 parent 1b85410 commit 4a3b875
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Digital Gender Gaps V2
The data for this project can be accessed via the dashboard (`http://3.11.85.207/dashboard/`) or the API (`http://3.11.85.207/api/v2/`). The API can be interacted with programatically, or via the Swagger UI (`http://3.11.85.207/api/v2/ui `), which also acts as the API documentation.
The data for this project can be accessed via the dashboard (`http://3.11.85.207/dashboard/`) or the API (`http://3.11.85.207/api/v2/`). The API can be interacted with programatically, or via the Swagger UI (`http://3.11.85.207/api/v2/ui `), which also acts as the API documentation. **THIS PAGE IS NOT INTENDED FOR DIRECT API INTERACTION, JUST AS DOCUMENTATION**

The application is managed by docker containers in the server machine. The `docker-compose.yaml` file orchestrating the application is in `/dgg-www`, and can be launched by running `docker-compose up --build` and torn down by running `docker-compose down` in this directory. The database is reinstantiated each time the containers are started, and the csvs in `/dgg-www/api/scripts/data` will be used for the database. This data can be replaced if required, but their names should stay the same. If you need to rename the csvs, please see the script `/dgg-www/api/scripts/insert_data.py` where these names are defined.
The application is managed by docker containers in the server machine. The `docker-compose.yaml` file orchestrating the application is in `/dgg-www`, and can be launched by running `docker-compose up --build` and torn down by running `docker-compose down` in this directory. The database data is persisted in a docker volume when the app is torn down (`docker-compose down`) unless the `-v` flag is used, in which case the data will be deleted. The csvs in `/dgg-www/api/scripts/data` will be used for the database. This data can be replaced if required, but their names should stay the same. If you need to insert data into the database after it has been wiped, please use the script `/dgg-www/api/scripts/insert_data.py`. Indicator tables can also be replaced/inserted using the `dgg-www/scripts/reinsert_all_data` - See `bulk insert script` below for instructions.

**If you need to replace indicator tables in the database, you can either replace them here, or run a script on the server machine to replace data in the running database. See Bulk Insert Script below for instructions**

Expand Down

0 comments on commit 4a3b875

Please sign in to comment.