Opsmap Toolkit

This document is aimed at helping developer understand this project.

At this point, it is just a place to drop every infos relatives to the project.

This document is NOT a comitment to anything. It is NOT an official technical specifications.

Resources:

• teamwork : task board
• teamwork : old
• nextcloud
• gitlab

People:

• Pole Manager: Sylvie de Laborderie
• PO: Maelle Aubert
• Main devs: Olivier Ribiere, Etienne Delclaux
• Devs: Joaquim Martin, Miguel Moreno
• Design: Lucile Collignon

Tech summary:

Front only, based on Vue.js v2 + Typescript + class-style Vue components. The map engine is Mapbox.

Usage

• npm run build --> generates the app (no lib)
• npm run serve --> generates the app (no lib) and start localhost
• npm run doc --> generates the doc in the docs folder

The doc is generated using TypeDoc. It doesn't seems to be ok with vuejs components. We'll see.

Kobo Management

A kobo user for this project has been created. The objective is to have a readonly access to every potential opsmap related survey.

For now, it is not valid. It requires pending specific authorization from UNHCR.

username: cartong_reader passwd: @bitwarden

Mapbox Account

The app is using the UNHCR MapBox account. Contact: [email protected]

A Mapbox account was initially dedicated for Opsmaps project username: [email protected]

Project architecture

For the seek of opsmap-tookit related files, variables, etc. , we will use the following prefix: TK. (ex: TKHellowWorld).

The code will be divide into libraries, packages, etc. The idea is to encapsulate stuff as musch as we can.

This code is the generic opsmap code. It is based on the FDF + data system. See project documentation for more informations.

This code was initially aimed at being integrated in a two elements system. You might encounter along the comments / doc / naming some trace of this. Just know that is has been forgotten since. opsmap --> opsmapToolKit

Current project description

The objective is to provide multiple components and tools to a typical oppsmap, the standard opsmap.

This project holds two differents projects:

• a lib declaration The entry point is entry-point-lib.ts of the lib. This is history

• an app implementation The two entry points are app/TKApp.vue and entry-point-app.vue

We observe the following folder structure:

src
├──app/
│   └── TKApp.vue
├──components
│   ├── TKComponent1
│   │     ├── index.ts
│   │     ├── TKComponent1.vue
│   │     ├── TKComponent1Subpart1.vue
│   │     └── TKComponent1Subpart2.vue
│   └── TKComponent2.vue
├──locales
│   ├── fr.json
│   └── en.json
├──plugins
│   └── vuetify.ts
└──domain
    └── TKdomain-related-stuff.ts

We observe the following behavior:

• components: the folder + file structure follows the components tree in the UI
• domain: attempt to structure. It holds the domain related competences.
• locales: traduction files. conforms to i18n standards. en.json act as a reference.
• plugins: auto, needed by vuetify

Domain description

This section provide tools to manipulate csv files, kobo, setup

Licences

The licence of this project is specified in LICENCE.md. The 3rd Party licences are mentionned in LICENCE-3RD-PARTY.md.

Used in this project

• Front
  • Vue.js v2: MIT Licence
  • Typescript: Apache v2.0
  • Mapbox: Custom Licence. Free under 50k users per month. OK With this project.
  • Chart.js: MIT Licence
  • PDF.js: MIT Licence
  • html2canvas: MIT Licence
• Tooling
  • TypeDoc: doc engine Apache 2.0
  • Jest: MIT Licence
  • sinonjs: BSD Licence
  • Cypress.io test runner: [MIT Licence](MIT licence) Others api used:
• Vue.js v2 + Typescript
• Mapbox: map engine (could try OpenLayers or MapLibre)
• Chart.js
• PDF.js + html2canvas: PDF extraction
• TypeDoc: doc engine
• Jest: testing framework
• sinonjs: improvement of Jest testing framework
• Cypress.io: end to end testing

MIT Licence

Permissive. Do whatever you want, only if:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

Apache V2

Permissive. Do whatever you want, only if:

You should include a copy of the Apache License, typically in a file called LICENSE, in your work, and consider also including a NOTICE file.

BSD Licence

Persmissive. Do whatever you want, only if:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of Christian Johansen nor the names of his contributors may be used to endorse or promote products derived from this software without specific prior written permission.