Skip to content

Commit

Permalink
🔧 adjust docker to match fragdenstaat_de, update readme + vscode exte…
Browse files Browse the repository at this point in the history
…nsions
  • Loading branch information
krmax44 committed Sep 16, 2024
1 parent a7d05c6 commit 5ce4553
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 7 deletions.
9 changes: 9 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"recommendations": [
"detachhead.basedpyright",
"vue.volar",
"vue.vscode-typescript-vue-plugin",
"charliermarsh.ruff",
"dbaeumer.vscode-eslint"
]
}
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,13 @@ pre-commit install

### Start services

You can run your own Postgres+PostGIS database and Elasticsearch service or run them with Docker.

You need [docker](https://www.docker.com/community-edition) and [docker-compose](https://docs.docker.com/compose/). Make sure Docker is running and use the following command:
You can run your own Postgres+PostGIS database and Elasticsearch service or run them with [Docker](https://docker.com):

```
docker-compose up
docker compose -f compose-dev.yaml up
```

This will start Postgres and Elasticsearch and listen on port 5432 and 9200 respectively. You can adjust the port mapping in the `docker-compose.yml`.
This will start Postgres and Elasticsearch and listen on port 5432 and 9200 respectively. You can adjust the port mapping in the `compose-dev.yaml`.

### Setup database and search index, start server

Expand Down Expand Up @@ -65,9 +63,9 @@ make testui

### Development tooling

For Python code, we use flake8 following black code style. JavaScript, Vue and SCSS files are formatted and linted with ESLint and Prettier.
For Python code, we use ruff for linting and formatting. JavaScript, Vue and SCSS files are formatted and linted with ESLint and Prettier.

Make sure to have pre-commit hooks registered (`pre-commit install`). For VSCode, the [Python](https://code.visualstudio.com/docs/python/linting), [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [Vetur](https://marketplace.visualstudio.com/items?itemName=octref.vetur) extensions are helpful, with these workspace settings recommended:
Make sure to have pre-commit hooks registered (`pre-commit install`). For VSCode, [we recommend some extensions](./.vscode/extensions.json)

```json
{
Expand Down
1 change: 1 addition & 0 deletions compose.yaml → compose-dev.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ services:
- es-data:/usr/share/elasticsearch/data
- es-logs:/var/log
environment:
- xpack.security.enabled=false
- discovery.type=single-node
- cluster.routing.allocation.disk.threshold_enabled=false
- cluster.routing.allocation.disk.watermark.low=3gb
Expand Down

0 comments on commit 5ce4553

Please sign in to comment.