Skip to content

Commit

Permalink
docs: add docker/kubernetes infos in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
davdarras committed May 3, 2023
1 parent 9544b92 commit 21111cb
Showing 1 changed file with 32 additions and 18 deletions.
50 changes: 32 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,24 @@ Contextualized questionnaire vizualisation tools developped with react/mui/vite

This project is directly linked with [Public Enemy Backoffice](https://github.com/InseeFr/Public-Enemy-Back-Office/) to create and save questionnaires.

## Global project concept

Public-Enemy (& backoffice) is a tool used to test questionnaires with data. Questionnaire designer create questionnaire in pogues but can't test them with predefined data directly. Public-Enemy gives to the designer the ability to inject a questionnaire in orchestrators (stromae, queen soon), and add predefined survey units data in the orchestrators for this questionnaire.

Public-Enemy's global functionalities for a designer:

- create a questionnaire in public-enemy
- retrieve the questionnaire from pogues
- create the questionnaire in public-enemy
- inject the questionnaire and survey units data (given by the designer when creating questionnaire in public-enemy) in the orchestrators
- update a questionnaire in public-enemy
- synchronise the questionnaire with the orchestrators (when pogues questionnaire has been edited for example, or to change survey units data)
- delete a questionnaire in public-enemy
- delete questionnaire in orchestrators
- access to questionnaire in orchestrators
- designer can access to a questionnaire in orchestrators for a specific survey unit
- designer can reset a specific survey unit data

## Requirements

For building and running the application you need:
Expand All @@ -23,14 +41,20 @@ yarn
yarn start
```

## Docker/Kubernetes

A Dockerfile is present on this root project to deploy a container. You can [get docker images on docker hub](https://hub.docker.com/r/inseefr/public-enemy/tags)

[Helm chart repository](https://github.com/InseeFr/Helm-Charts/) is available for the public-enemy backoffice/frontend

The repository contains helm charts to deploy pogues/eno/stromae too.

## Create a production build

```shell
yarn run build
```

A dockerfile is present to create a container, you can [get docker images on docker hub](https://hub.docker.com/r/inseefr/public-enemy/tags)

### Configuration

Before launching app, you must set up some environment variables:
Expand Down Expand Up @@ -64,23 +88,13 @@ For docker, the environment variables can be injected as system environment vari
- eslint
- semantic-release

## Global project concept

Public-Enemy (& backoffice) is a tool used to test questionnaires with data. Questionnaire designer create questionnaire in pogues but can't test them with predefined data directly. Public-Enemy gives to the designer the ability to inject a questionnaire in orchestrators (stromae, queen soon), and add predefined survey units data in the orchestrators for this questionnaire.

Public-Enemy's global functionalities for a designer:
## Before you commit

- create a questionnaire in public-enemy
- retrieve the questionnaire from pogues
- create the questionnaire in public-enemy
- inject the questionnaire and survey units data (given by the designer when creating questionnaire in public-enemy) in the orchestrators
- update a questionnaire in public-enemy
- synchronise the questionnaire with the orchestrators (when pogues questionnaire has been edited for example, or to change survey units data)
- delete a questionnaire in public-enemy
- delete questionnaire in orchestrators
- access to questionnaire in orchestrators
- designer can access to a questionnaire in orchestrators for a specific survey unit
- designer can reset a specific survey unit data
Before committing code please ensure,
1 - README.md is updated
2 - A successful build is run and all tests are successful
3 - All newly implemented APIs are documented
4 - All newly added properties are documented

## License

Expand Down

0 comments on commit 21111cb

Please sign in to comment.