Skip to content

helsingborg-stad/gdi-cases-server

Repository files navigation

MIT License

Logo

GDI Cases Server

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Acknowledgments

About The Project

Cases services for GDI.

  • REST endpoint for uploading federated case descriptions

The general reasoning behind this solution is that

  • a citizen can expect to be given a normalized, standardized and homogenized view of her involvment with a go (a Citverning entityy for example)
  • the government has internallyu a plethora of various processes and software systems supporting dialogs (i.e. cases) with citizens
  • Onboarding of case management systems should NOT rely on direct, ad-hoc runtime integration but rather frequent imports of current state in respective case management system
  • Each case managament system exporter is responsible for
    • publishing intervals
    • data safety and governance (GDPR etc)

(back to top)

Getting Started

Configure environment variables

In order to run, some environment variables must be defined. This is easiest to do by

  • ensuring there exists a local .env in the project root
  • copy content from .env.example and change values to what gives meaning

(back to top)

Setup a datalayer

(back to top)

Integrations

(back to top)

Roadmap

  • Improve testcoverage (MongoDB being an external dependency is currently a obstacle)

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Acknowledgments

(back to top)