FightPandemics / DataModel

FightPandemics data model documentation and scripts

Home Page:https://fightpandemics.github.io/DataModel/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


FightPademics logo

FightPandemics Data Model


Repository holding the data model specified as json document, json schema and with its html and pdf documentation.

The data model is versioned, with the current live version being v1 and with v2 being produced.

The HTML documentation is hosted at Github Pages at the following URL: https://fightpandemics.github.io/DataModel/

Diagram for the Data Model v2


Documentation

The documentation can be found in HTML and PDF. The HTML live version is highly recommended.

There is also an excel spreadsheet version.


Sample of the documentation


Specifications and Scripts

There are JSON Document and JSON Schema representations.

There are MongoDB Scripts available for collection creation, in JS with standard Mongo Shell flavor.

Mongoose scripts are in the roadmap for the near future.

Collections

Users

Collection that holds all the data on system's users.

The users can be of two types: (1) Individual, representing a private user account; and (2) Organization, representing an organization of various types.

The field 'type' is used to differentiate between the two subschemas, with 'individual' representing private user accounts and "Community", "Government", "Health care provider", "Non-profit", "Other", "R&D", "Startup", "Traditional Company" and "University".

For more detailed information, please visit the documentation.



Posts

Document to represent a post, asking or offering help to be displayed on the feed. A post can be created by any user, wether it is an individual or an organization. A post can have it's visibility limited geographically and have an expiration date set.

For more detailed information, please visit the documentation.



Comments

Document that represents a comment made at a post. A comment can be made by an individual user or an organization.

For more detailed information, please visit the documentation.



Feedback

Document that represents a feedback sent by an user, logged or not.

For more detailed information, please visit the documentation.



About

FightPandemics data model documentation and scripts

https://fightpandemics.github.io/DataModel/


Languages

Language:HTML 99.5%Language:JavaScript 0.5%