Merged in onboarding-mockup (pull request #35)

Onboarding mockup

Author: n0rdlicht

Makefile

@@ -3,6 +3,10 @@ DOCKER_EXEC_DJANGO=$(shell command -v docker > /dev/null && echo "docker-compose
 DOCKER_EXEC_VUE=$(shell command -v docker > /dev/null && echo "docker-compose exec vue")
 DOCKER_EXEC_WWW=$(shell command -v docker > /dev/null && echo "docker-compose exec www")
 
+DOCKER_CRON_VUE=$(shell command -v docker > /dev/null && echo "docker-compose exec -T vue")
+DOCKER_CRON_DJANGO=$(shell command -v docker > /dev/null && echo "docker-compose exec -T django")
+
+
 .PHONY: tests
 
 init:
@@ -12,10 +16,17 @@ init:
 up:
 	docker-compose up -d
 
+down: stop
+
+stop:
+	docker-compose stop
+
 build_docker:
 	cd django && make build_docker
 	cd vue && make build_docker
 
+build: build_docker
+
 push:
 	cd django && make push
 	cd vue && make push
@@ -29,6 +40,11 @@ enter_vue:
 enter_www:
 	$(DOCKER_EXEC_WWW) ash
 
+start_all: up
+	$(DOCKER_CRON_VUE) make &
+	$(DOCKER_CRON_DJANGO) make &
+	$(DOCKER_CRON_VUE) make screenshotservice &
+
 start_vue:
 	$(DOCKER_EXEC_VUE) make
 

README.md

@@ -1,8 +1,22 @@
-# Gemeindescan Web UI
+# Gemeindescan Web
 
-Web application under heavy development. For more information, please visit https://cividi.ch
+A web application for publishing and collaborating around urban planning projects. This project is part of the  [Cividi](https://cividi.ch) solution for holistic urban assessments, used as a tool for setting planning priorities.
 
-The current tech stack of this project is:
+For more information, please visit [Gemeindescan.ch](https://gemeindescan.ch) and read our [Whitepaper](https://bitbucket.org/cividi/whitepaper).
+
+# Additional documentation
+
+- [Release notes](./RELEASE.md)
+- [Architecture](./docs/architecture.md)
+- [Troubleshooting](./docs/troubleshooting.md)
+- [Test guide](./docs/testing.md)
+- [Django](./docs/django.md)
+- [GraphQL](./docs/graphql.md)
+- [Further links](./docs/links.md)
+
+# Developer guide
+
+:construction: The current tech stack of this project is:
 
 - Vuetify
 - Vue.js
@@ -12,15 +26,7 @@ The current tech stack of this project is:
 - Wagtail
 - Docker
 
-# Releases
-
-*See [RELEASE.md](/RELEASE.md)*
-
-# Developer guide
-
-:construction:
-
-For a tour of the app and a testing protocol see [`docs/testing.md`](/docs/testing.md).
+For a tour of the app and a testing protocol see [`docs/testing.md`](./docs/testing.md).
 
 ## setup project
 
@@ -76,6 +82,14 @@ GraphQLi: http://www:8000/graphql
 
 **start services**
 
+Start all the services at the same time using
+
+```bash
+make start_all
+```
+
+or individually using:
+
 ```bash
 # 1. shell
 make start_vue
@@ -87,6 +101,12 @@ make start_screenshotservice
 
 You can also start the vue / django service from the vscode shell (see editor).
 
+**stop services**
+
+```bash
+make stop
+```
+
 ### tests
 
 ```bash
@@ -126,11 +146,3 @@ Type `make` in the vscode terminal, that creates the django dev server on your m
 ## deploy
 
 Type `make deploy_prod` in the project root. The file `env.hosts.prod` needs to have the right settings.
-
-## additional docs
-
-- [architecture](/docs/architecture.md)
-- [django](/docs/django.md)
-- [links](/docs/links.md)
-- [grahpql](/docs/graphql.md)
-- [troubleshooting](/docs/troubleshooting.md)

RELEASE.md

@@ -2,6 +2,37 @@
 
 ## Releases
 
+### 0.6.1
+[Released: *2020-09-03*](https://bitbucket.org/cividi/gemeindescan-webui/commits/tag/0.6.1)
+
+- Improved snapshot loading and switching
+
+### 0.6.0
+[Released: *2020-08-04*](https://bitbucket.org/cividi/gemeindescan-webui/commits/tag/0.6.0)
+
+- Added snapshot sections in workspaces and municipalities based on topic
+
+### 0.5.1
+[Released: *2020-05-27*](https://bitbucket.org/cividi/gemeindescan-webui/commits/tag/0.5.1)
+
+- Improved OpenGraph Support
+- Improved screenshot server
+
+### 0.5.0
+[Released: *2020-05-20*](https://bitbucket.org/cividi/gemeindescan-webui/commits/tag/0.5.0)
+
+- Added OpenGraph support for public snapshots (rich social media links)
+- Improved error messages in frontend
+- Improved screenshot server
+- Improved django backend
+
+### 0.4.0
+[Released: *2020-05-11*](https://bitbucket.org/cividi/gemeindescan-webui/commits/tag/0.4.0)
+
+- Added PNG downloads
+- Added screenshot server
+- Added Django and Vue tests
+
 ### 0.3.1
 [Released: *2020-04-09*](https://bitbucket.org/cividi/gemeindescan-webui/commits/tag/0.3.1)
 [Sprint: 4 "Out of the Box"](https://bitbucket.org/cividi/gemeindescan-webui/issues?milestone=SP+4%3A+Out+of+the+box)

docker-compose.yml

@@ -32,7 +32,7 @@ services:
       - VUE_APP_MAPBOX_DEFAULT_STYLES=mapbox://styles/gemeindescan/ck6rp249516tg1iqkmt48o4pz
     working_dir: /opt/vue
     volumes:
-      - ./vue:/opt/vue
+      - ./vue:/opt/vue:Z
       - var-gemeindescan-webui:/var/services/
       - vscode-remote-vue:/root/.vscode-server
     ports:
@@ -60,7 +60,7 @@ services:
       - DJANGO_ADMIN_HEADER_COLOR=#ff0000
     working_dir: /opt/app
     volumes:
-      - ./django:/opt/app
+      - ./django:/opt/app:Z
       - var-gemeindescan-webui:/var/services
       - vscode-remote-django:/root/.vscode-server
     ports:
@@ -72,7 +72,7 @@ services:
     image: openresty/openresty:1.15.8.3-alpine
     hostname: www
     volumes:
-      - ./etc/nginx:/etc/nginx/conf.d
+      - ./etc/nginx:/etc/nginx/conf.d:Z
       - var-gemeindescan-webui:/var/services
     ports:
       - 8000:8000

docs/architecture.md

@@ -1,6 +1,6 @@
-# architecture
+# Architecture
 
-## django
+_Notes on the architecture of the project._
 
 We switch to graphne + django. Our main goal is to have a backend service that speaks graphql. FastAPI doesn’t brings much to the table in this regard.
 The focus of FastAPI Is OpenAPI which is REST based. Also Swagger UI is build for REST. The graphql part is just reused from Starlette which itself uses graphene.

docs/django.md

@@ -1,4 +1,6 @@
-# django
+# Django
+
+_Notes on our usage of the Django Framework._
 
 ## init project
 

docs/graphql.md

@@ -1,9 +1,11 @@
-# graphql
+# GraphQL
 
-go to '/graphql/' which opens the GraphiQL browser
+_Notes on our usage of the GraphQL-based query API._
 
 ## sample queries
 
+go to '/graphql/' which opens the GraphiQL browser
+
 ### gemeinden
 
 ```graphql
@@ -45,5 +47,3 @@ The `MunicipalityNode` has the fields
   }
 }
 ```
-
-

docs/links.md

@@ -1,4 +1,4 @@
-# links
+# Further References
 
 ## django
 

docs/troubleshooting.md

@@ -1,15 +1,15 @@
-# troubleshooting
+# Troubleshooting
 
 ## init
 
 If you want/need a clean state you can delete the var docker volume.
 `docker volume rm var-gemeindescan-webui`
 
-## vscode 
+## vscode
 
 If you have a vscode related problem it could help to delete the vscode docker volume.
-- django: `docker volume rm gemeindescan-webui_vscode-remote-django` 
-- vue: `docker volume rm gemeindescan-webui_vscode-remote-vue` 
+- django: `docker volume rm gemeindescan-webui_vscode-remote-django`
+- vue: `docker volume rm gemeindescan-webui_vscode-remote-vue`
 
 ## windows
 

vue/.env.production

@@ -1,3 +1,4 @@
 VUE_APP_GRAPHQL_URI=/graphql/
 VUE_APP_DJANGOBASEURL=
+VUE_APP_SNAPSHOTSTOREURL=
 VUE_APP_FATHOM_SITEID=