Vergunningcheck

This application allows residents of Amsterdam to easily see if they need a permit for a construction activity for their specific building. For various activities, like installing a window or solar panels on the roof or extending the house, we ask a number of questions about the location and plans. This leads to an outcome, either license-free or licensing obligation, where it is clear which questions lead to this conclusion. This tool can therefore be used to see how in a specific location you could carry out a construction activity without the requirement of a permit.

Install / run

This repo contains 2 apps, client and graphql. We use Lerna under the hood to install deps and run on both apps. But you can also run and configure then individually.

npm i
npm start

Contributing

If you want to contribute to this project please read CONTRIBUTING.md

Prepare a release

Basically what we want to do is merge develop with release including the latest STTR-changes. Two commands make this easy for you. Run npm run prepare-release, commit changes if needed and npm run release.

Publish a release

We use lerna-changelog to generate our changes we can use in CHANGELOG.md, so you'll need a personal access token for the GitHub API with the public_repo scope for public repositories. Make sure you are logged in by npm command line. If not, log in with npm adduser.

Add export GITHUB_AUTH=... to your profile (eg: .zshrc).

• Run npm run version and use the generate our changes we can use in CHANGELOG.md
• Determine the version number.
• Commit the changelog.
• Run npm run publish and answer y to the prompt
• Create a new PR from release to master on GitHub
• After the merge the release will be deployed to acceptance, manually verify the changes
• Approve the release to production in Jenkins
• Back-merge master into release into develop by running npm run back-merge
• Consider preparing the next release in the section above

Tech stack

• React
• React Hook Form
• GraphQL + ApolloClient v3
• Lerna
• Sentry
• Amsterdam Styled Components
• Matomo Tracker React
• Prettier
• Jest + Testing Library

Known issues

• css sourcemaps (some issues exist in development, in prod it works, see facebook/create-react-app#6399)
• we are not on the latest version of react-scripts because 3.4.1 does not play well with Lerna. See facebook/create-react-app#8685

Thanks to