https://github.com/HierBautBerlin/website
A tool to inform citizens of Berlin about changes in their neighborhood.
https://github.com/HierBautBerlin/website
berlin prototype-fund
Last synced: over 1 year ago
JSON representation
A tool to inform citizens of Berlin about changes in their neighborhood.
- Host: GitHub
- URL: https://github.com/HierBautBerlin/website
- Owner: HierBautBerlin
- License: mit
- Created: 2021-02-11T07:06:49.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-11-12T07:26:54.000Z (over 2 years ago)
- Last Synced: 2024-07-31T20:37:10.153Z (almost 2 years ago)
- Topics: berlin, prototype-fund
- Language: Elixir
- Homepage: http://hierbautberlin.de
- Size: 5.68 MB
- Stars: 21
- Watchers: 2
- Forks: 3
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Hier Baut Berlin
A tool to visualize and inform citizens of Berlin about governmental decisions.
[](https://github.com/HierBautBerlin/website/actions/workflows/elixir.yml)
**You want to help?** Awesome. Scroll through the issues, open a new one, or just send
a short notice to [mail@hierbautberlin.de](mailto:mail@hierbautberlin.de). We are happy about every person who wants to help.
## Development setup
HierBautBerlin uses Elixir and Phoenix. Information on how
to install Elixir can be found [here](http://elixir-lang.org/install.html).
As database it uses [PostgreSQL](http://postgresql.org).
After you installed everything, the setup is as follows:
```bash
make update
make setup
make start
```
Before you contribute code, please make sure to read the [CONTRIBUTING.md](CONTRIBUTING.md)
This project is using [yarn](http://yarnjs.com/) for javascript dependency management.
## How to run the test suite
```bash
make check
```
You can also run the `ExUnit` tests in watch mode with:
```bash
make run-tests
```
## Download geo objects
This system needs the list of streets and places of a city to have a working text parser. To download the data and parse them into the database you need to execute the `./bin/download_geo_objects.s` script. It will download a couple of hundred megabytes of data.
## Deployment
The server is configured using [ansible](https://www.ansible.com/) with [this playbook](/ansible/playbook.yml) and can be updated with:
```bash
ansible-playbook ansible/playbook.yml -i ansible/hosts --extra-vars '{"username": "***********"}'
```
Deploy is done by running:
```bash
VERSION=`git rev-parse HEAD`
make prod-build
scp build/hierbautberlin-$VERSION.tar.gz user@server:~/hierbautberlin
ssh user@server 'bash -s' < bin/deploy.sh $VERSION
```
## Funding
This project is funded by the [German Federal Ministry of Education and Research](http://bmbf.de)
and is part of the 9th batch of the [prototype fund](http://prototypefund.de).
