lightweight/right-tree
1
0
Fork 0
Code Issues 17 Pull requests Projects Releases Packages Wiki Activity Actions

Update readme

Browse source 
- Adds docs for production commands
- Adds docs for preparing zones for habitat images
This commit is contained in:
Dana Lambert 2021-12-17 19:17:41 +13:00
parent ba512c1f5a
commit 19aea556b0
2 changed files with 15 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -121,8 +121,21 @@ A summary of available commands are outlined below. Note that if the command req
| `reset_database` | Removes, recreates and populates the database | No | `reset_database` | Removes, recreates and populates the database | No
| `build` | Builds required images | No | `build` | Builds required images | No
| `start` | Runs all services including the frontend, backend and postgres database | No | `start` | Runs all services including the frontend, backend and postgres database | No
| `build` | Builds required images (frontend and backend) for production | No | `build` | Builds required images (frontend and backend) for development | No
| `start` | Runs all services in production mode including the frontend, backend and postgres database | No | `build_production` | Builds required images (frontend and backend) for production | No
| `start_production` | Runs all services in production mode including the frontend, backend and postgres database | No
| `renew_certificate` | Renews certificates for production | No
| `process_svg_files` | Removes semi-colons from raw svg files to be compatible with the application | No
## Creating zones for habitat images
1. Create png image from original svg with approprate crop.
2. Create zone polygons/rectangles on the original svg with divider lines anchor points as a guide
3. Copy zone polygons/rectangles to png image and size to fit (this is to ensure the only paths on the image the selectable ones)
4. Ensure all overlays have an almost transparent fill (lowest transparency value - in Inkscape this is 1) and no outline
5. Add a 'label' (not an id) to each overlay to match with a column name relating to the zone segment, this may be repeated. In Inkscape this is under 'Object Properties'.
6. Save the png with overlays as an svg (it may either be inkscape or plain svg)
7. Place svg in relevant directory (`./frontend/src/assets/img/habitatSVG/`) in the frontend
8. Find and replace any instance of colons (:) in property names for the raw svg i.e. inkscape:label -> inkscapelabel. A helper script has been written to do this automatically please run `python process_svg.py`.
## Setting up and running the application for production ## Setting up and running the application for production

4
dev
View file

@ -123,10 +123,6 @@ cmd_stop_production() {
docker-compose -f docker-compose.production.yaml stop --remove-orphans docker-compose -f docker-compose.production.yaml stop --remove-orphans
} }
cmd_stop_production() {
docker-compose -f docker-compose.production.yaml stop --remove-orphans
}
cmd_renew_certifcate() { cmd_renew_certifcate() {
cmd_stop_production cmd_stop_production
sudo docker run -i --rm --name certbot -p 443:443 -p 80:80 -v /etc/letsencrypt:/etc/letsencrypt/ certbot/certbot renew --dry-run -d $BASE_URL --logs-dir /etc/letsencrypt/logs sudo docker run -i --rm --name certbot -p 443:443 -p 80:80 -v /etc/letsencrypt:/etc/letsencrypt/ certbot/certbot renew --dry-run -d $BASE_URL --logs-dir /etc/letsencrypt/logs