https://github.com/justb4/alpumapa.xyz
Content for OpenStreetMap Workshop the The Alpujarras, Andalusia, Spain.
https://github.com/justb4/alpumapa.xyz
alpujarras everydoor mapping openstreetmap spain streetcomplete
Last synced: 3 days ago
JSON representation
Content for OpenStreetMap Workshop the The Alpujarras, Andalusia, Spain.
- Host: GitHub
- URL: https://github.com/justb4/alpumapa.xyz
- Owner: justb4
- License: cc0-1.0
- Created: 2025-01-11T14:25:17.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-08-27T09:18:35.000Z (2 months ago)
- Last Synced: 2025-08-28T18:01:33.188Z (2 months ago)
- Topics: alpujarras, everydoor, mapping, openstreetmap, spain, streetcomplete
- Language: Shell
- Homepage: https://alpumapa.xyz/
- Size: 19.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# alpumapa.xyz website
The files and dirs below are content for an OpenStreetMap Workshop.
This workshop was initially provided at the [FOSS4GNL 2023](https://foss4g.nl) and expanded
for workshops in Alpujarra, Spain.
The documentation is powered by [MkDocs](https://www.mkdocs.org)
which facilitates easy management
of content and publishing. Content is written in Markdown.
Using [GitHub Workflows](.github/workflows/deploy.docs.yml) the website is automatically rebuilt and deployed
(to the `gh-pages` branch on GitHub) on commit/pushes to the `main` branch.
The site is hosted as a static html website at [alpumapa.xyz](https://alpumapa.xyz)
on GitHub using GitHub Pages.
## Build/test locally
```bash
# build a virtual Python environment in isolation
# For example, or use pyenv.
python3 -m venv .
. bin/activate
# fork or clone from GitHub
git clone https://github.com/justb4/alpumapa.xyz.git
cd docs
# install required dependencies
# Optional: install lxml quickly using package
apt-get install -y python3-lxml
# install Python libs
pip install -r requirements.txt
# build the website
mkdocs build
# serve locally
mkdocs serve # website is made available on http://localhost:8000
# or locally on specific port
mkdocs serve -a localhost:8001
```
## Deploying to live site
Website updates are automatically published
via [GitHub Actions](.github/workflows/deploy.docs.yml).
Or to publish manually, but this is in general not needed:
```bash
# NOTE: you require access privileges to the GitHub repository
# to publish live updates
mkdocs gh-deploy -m 'add new page on topic x'
```