Skip to content
Snippets Groups Projects
Commit 3d840642 authored by sandcha's avatar sandcha
Browse files

Format doc on .env configuration file

parent 3d56d4a5
No related branches found
No related tags found
No related merge requests found
......@@ -31,18 +31,18 @@ LexImpact has two components:
# How to use
```
```shell
npm install
npm run dev
```
## Configuration file `.env`
A file name .env is necessary for the client to work properly. The file .env.example can be copied into it.
A file name `.env` is necessary for the client to work properly. The file `.env.example` can be copied into it.
Variables of environment that should be set are:
- API_URL : leximpact-client is just a web interface, that does not do computations by itself, but needs to be provided a working [Leximpact-server](https://github.com/betagouv/leximpact-server/) endpoint to fetch results. As of 2019-11-06, a working API example can be found on the endpoint https://api.leximpact.beta.gouv.fr
- PORT : describes the port that the client will be setup to (e.g. the website will be accessible from http://127.0.0.1:<PORT> if the client is run locally). If ommited, defaults to 9001
Here ate the environment variables that you have to set:
- `API_URL`: leximpact-client is just a web interface that does not do computations by itself, but needs to be provided a working [leximpact-server](https://github.com/betagouv/leximpact-server/) Web API to fetch results. As of v`1.0.0`, a working API example can be found on: https://api.leximpact.beta.gouv.fr
- `PORT`: describes the port that the client will be setup to (e.g. the website will be accessible from http://127.0.0.1:<PORT> if the client is run locally). If ommited, defaults to `9001`
# Snapshots Jest (Tests)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment