The Urbanoe platform uses a lot of Javascript. To ensure consistency through the different parts of the system, we decided to use Flow. The present module defines a set of classes, types and constructs that define a common domain model when using Urbanoe. Most of the constructs defined here are reflected in the REST API. For example, if you want to know about a certain issue, you would receive an "IssueDetailsData" structure.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
urbanoe-common is an npm module and can be downloaded from the npm registry.
Using npm:
npm i --save urbanoe-model
Using yarn:
yarn add urbanoe-model
If submitting code, please ensure that your code follows the eslint rules we use. Thanks.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Martin Beauvais - Initial work - mbeauv
See also the list of contributors who participated in this project.
This project is licensed under the Apache v 2.0 License - see the LICENSE.md file for details