README.md 1.69 KB
Newer Older
Ivan Gabriele's avatar
Ivan Gabriele committed
1 2 3 4 5
# Back-office du code du travail numérique

[![Build Status][img-travis]][link-travis]
[![codecov][img-codecov]][link-codecov]

Ivan Gabriele's avatar
Ivan Gabriele committed
6 7
> Ce dépôt regroupe les applications d'administration des données du [code du
> travail numérique][link-cdtn].
Ivan Gabriele's avatar
Ivan Gabriele committed
8

Ivan Gabriele's avatar
Ivan Gabriele committed
9
## Contribuer au projet
Ivan Gabriele's avatar
Ivan Gabriele committed
10 11 12 13

> ### :warning: Travail en cours
> Ce dépôt n'est pas encore fonctionnel.

Ivan Gabriele's avatar
Ivan Gabriele committed
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
### Pré-requis

- Node v10+
- Docker v18+
- Docker Compose v1.17+
- Yarn (`npm i -g yarn`)

### Installation

```bash
git clone https://github.com/SocialGouv/code-du-travail-backoffice.git
cd code-du-travail-backoffice
yarn
yarn setup
```

Ivan Gabriele's avatar
Ivan Gabriele committed
30 31
> **Note**<br>
> Si vous ne pouvez exécuter `docker-compose` qu'avec `sudo`, vous devez
Ivan Gabriele's avatar
Ivan Gabriele committed
32 33 34
> remplacer `yarn setup` par `sudo yarn setup`. La logique est similaire si
> vous utilisez Windows et nécessitez de démarrer `docker-compose` en tant
> qu'administrateur.
Ivan Gabriele's avatar
Ivan Gabriele committed
35

Ivan Gabriele's avatar
Ivan Gabriele committed
36 37
### Démarrer le site localement

Ivan Gabriele's avatar
Ivan Gabriele committed
38 39
Dans 2 sessions de terminal differentes:

Ivan Gabriele's avatar
Ivan Gabriele committed
40
```bash
Ivan Gabriele's avatar
Ivan Gabriele committed
41
docker-compose up api
Ivan Gabriele's avatar
Ivan Gabriele committed
42 43 44
```

```bash
Ivan Gabriele's avatar
Ivan Gabriele committed
45 46 47 48 49 50
yarn dev
```

Et c'est tout! Le site devrait être accessible via http://localhost:3100.

## Licence
Ivan Gabriele's avatar
Ivan Gabriele committed
51 52 53

Ce dépôt est licencié sous la [licence Apacha 2.0][link-license].

Ivan Gabriele's avatar
Ivan Gabriele committed
54
[img-codecov]: https://img.shields.io/codecov/c/github/SocialGouv/code-du-travail-backoffice/master.svg?style=flat-square
Ivan Gabriele's avatar
Ivan Gabriele committed
55 56 57 58
[img-travis]: https://img.shields.io/travis/SocialGouv/code-du-travail-backoffice/master.svg?style=flat-square
[link-cdtn]: https://github.com/SocialGouv/code-du-travail-numerique
[link-codecov]: https://codecov.io/gh/SocialGouv/code-du-travail-backoffice
[link-license]: https://github.com/SocialGouv/code-du-travail-backoffice/blob/master/LICENSE
Ivan Gabriele's avatar
Ivan Gabriele committed
59
[link-postgrest]: http://postgrest.org
Ivan Gabriele's avatar
Ivan Gabriele committed
60
[link-travis]: https://travis-ci.org/SocialGouv/code-du-travail-backoffice