Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tardog/schutzstreifen
Interactive map with user-contributed hazards for cyclists, such as dangerous intersections, unsafe or missing cycle lanes, parking cars.
https://github.com/tardog/schutzstreifen
bicycle-infrastructure buffalo-framework cyclists golang
Last synced: 6 days ago
JSON representation
Interactive map with user-contributed hazards for cyclists, such as dangerous intersections, unsafe or missing cycle lanes, parking cars.
- Host: GitHub
- URL: https://github.com/tardog/schutzstreifen
- Owner: Tardog
- Created: 2019-01-25T09:45:05.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-18T23:03:45.000Z (11 months ago)
- Last Synced: 2024-06-21T17:55:02.632Z (5 months ago)
- Topics: bicycle-infrastructure, buffalo-framework, cyclists, golang
- Language: Go
- Homepage:
- Size: 216 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Schutzstreifen
A web application that displays a map with user-contributed hazards for cyclists.
Built with the [Buffalo framework](https://gobuffalo.io).
## What's the meaning of the project name?
"Schutzstreifen" is German for "protective strip". In legal terminology, it describes the kind of cheap bicycle path that gets painted on the road, often leading to conflicts between drivers and cyclists due to cars parking on or too close next to the strip, close passes on the road, among others. Many of these contraptions are inherently unsafe for cyclists, which has earned them the nickname of "Gefährdungsstreifen" (literally "hazard strip").
## ⛔️ Attention: Work in progress ⛔️
This application is not feature ready yet (as in: pre-alpha status):
- Several routes are only implemented in the most basic way possible
- Validation and error handling require work to improve security and user experience
- The frontend is pretty bare-bones right now and needs a lot of love and polish to be presentable
- Every single user has access to all POST endpoints, which is not desirable - there should be an admin user e.g. for managing available hazard types, removing users etc.
When the first alpha is ready, the app will be made available online. You can always download the code and run it on your local machine, of course.
## Installation
If you are setting up the application for the first time, use the following make target:
```
make setup
```
## Run locally
For development, having Go and Go dev tools installed on your machine is extremely helpful.
Instead of also installing Buffalo and PostgresSQL, you can simply run the app with Docker. Otherwise, please refer to the Buffalo documentation on how to run the framework natively.
Use the following make commands to start/stop the containers:
```
make start
make stop
```
When all containers are up, the application is available at http://localhost:22080/
To see debug output (logs) during development, use the following start command instead:
```
make start-dev
```
### Display container log output
With the default ```start``` target, containers are started in detached mode. If you prefer running them in the foreground, use the ```make start-dev``` target instead.
## Run tests
```
make test
```
## Buffalo CLI
Use this shortcut to open a shell inside the dev container. You can then use the full Buffalo CLI, including Pop for setting up the database and running migrations:
```
make cli
```
## Force rebuilding containers
This will skip the Docker build cache.
```
make build-containers
```
## Compile CSS
Create CSS files from Sass sources:
```
make css
```
## Run database migrations
Execute all migrations (only works if the database already exists).
```
make migrate
```