chaostreff.ch/README.md

58 lines
1.5 KiB
Markdown
Raw Normal View History

2023-01-04 02:32:00 +01:00
# chaostreff.ch
Source code and build scripts for [chaostreff.ch](https://chaostreff.ch/)
2023-01-04 03:05:25 +01:00
## Production Deployment
2023-01-04 02:32:00 +01:00
```shell-session
$ python3 -m virtualenv venv
$ . venv/bin/activate
(venv) $ pip install -r requirements.txt
(venv) $ ./build.py
```
2023-01-04 03:05:25 +01:00
Then deploy the contents of `out/` to the webroot.
2023-01-04 02:32:00 +01:00
2023-01-04 03:05:25 +01:00
To make the site really usable, the following features should be configured:
* A proxying service for SpaceAPI endpoints (since some of them don't set CORS headers)
* Automatic redirection to the correct language subpage based on the `Accept-Language` header
An example configuration for Apache httpd can be found in the `httpd.conf` file.
## Local Development Setup
2023-01-04 02:32:00 +01:00
```shell-session
$ python3 -m virtualenv venv
$ . venv/bin/activate
(venv) $ pip install -r requirements.txt
(venv) $ ./build.py
2023-01-04 03:05:25 +01:00
(venv) $ ./run.py
2023-01-04 02:32:00 +01:00
```
2023-01-04 03:05:25 +01:00
run.py includes a SpaceAPI proxy to work around missing CORS headers.
2023-01-04 02:32:00 +01:00
## License
With exception of the sources listed below, this project is licensed under the [MIT License](LICENSE).
### `static/*/bootstrap*`
* Copyright (c) 2011-2023 The Bootstrap Authors
* MIT License
* https://github.com/twbs/bootstrap
### `static/{css,js}/leaflet*`
* Copyright (c) 2010-2022, Volodymyr Agafonkin
* Copyright (c) 2010-2011, CloudMade
* BSD-2-Clause license
* https://github.com/Leaflet/Leaflet
### `static/img/leaflet-marker-*`
* Copyright (c) 2010-2019, Vladimir Agafonkin
* Copyright (c) 2010-2011, CloudMade
* Copyright (c) 2013-2020, Thomas Pointhuber
* BSD-2-Clause license
* https://github.com/pointhi/leaflet-color-markers