Gemeente-DenHaag / mijngemeente-gateway

Public proxy gateway for the OpenZaak API.
Other
1 stars 0 forks source link

Mijn Gemeente Gateway

Public proxy gateway for the OpenZaak API. Built for usage in the Mijn Gemeente PWA

TypeScript

🚀 Getting started

  1. Clone this repository
  2. Install Node, go here for instructions. Make sure to install version 14 or higher.
  3. Install Yarn, go here for instructions. Make sure to install version 1.22 or higher.
  4. Run the following command to install all development dependencies:
    yarn install
  5. yarn start;

To view the project you can open http://localhost:3030.

Environment variables

In order to run the project you need to add a .env to the root directory. Make sure it contains the variables defined in the .env.example file.

🤝 Contributing

  1. Pick an issue;
  2. Fork this repository;
  3. Create your branch: git checkout -b my-new-feature;
  4. Commit your changes: git commit -m 'Add some feature';
  5. Push to the branch: git push origin my-new-feature.

After your pull request is merged, you can safely delete your branch.