edgalindo / zlb-app

Prototype of the ZLB Citizen Terminal

ZLB Citizen Terminal

Prototype of the ZLB Citizen Terminal. The prototype uses Eleventy as a page builder, a pipeline for processing SCSS and a webpack setup to bundle JavaScript.

In order to develop locally, you will need to create a .env file in your local root directory. The file should contain a Mapbox access token and should look like this:

MAPBOX_TOKEN=YOUR_ACCESS_TOKEN_HERE

The access token is required to load the map tiles of Mapbox.

Updating level3.json Information (via Scraping)

The level3.json information can be generated from: https://github.com/technologiestiftung/berlin-service-harvester (rename service-output.json to level3.json and replace the file)

Workflow

The master branch (soon to be renamed to main) is the main branch of the project. Do not push directly to this branch. Instead, development should happen on dedicated feature branches:

1. Start a new branch from master
2. Write your code
3. Push your feature branch to the remote
4. Create a Pull Request against the master branch (including a brief description of your changes)
5. If all is fine, the changes can be merged into master

If possible, use Conventional Commits for an explicit commit history.

Getting started

Install dependencies

npm install

Develop

npm run dev

The site is then deployed to the _site folder and served locally.

Build

npm run build

Deployment

The prototype is currently deployed to netlify. Changes to master will automatically trigger a re-deploy of the site. The create-env.js file is needed for the netlify deployment.