diff --git a/README.md b/README.md index 4a03a67b243150466eecdda43edf1fe0925f33f1..38662bdfc984186abd7626841f474770f2d5735b 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ for development $ pip install -r requirements.txt $ pip install -r requirements-dev.txt -To compile the CSS stylesheets and JS scripts, install npm, then run +To compile the CSS stylesheets and JS scripts, [install npm](https://www.npmjs.com/get-npm), then run the following commands to run yarn (to fetch and install dependencies) and webpack (to compile local assets) @@ -19,6 +19,8 @@ webpack (to compile local assets) $ yarn install $ webpack +In case you want to use the fixtures, you will need to install (git-lfs)[https://git-lfs.github.com/]. + ## Settings Create a file in `project/settings/env.py` which contains django @@ -41,19 +43,19 @@ the FQDN of the RP before being able to run in production If DEBUG is defined as True, ALLOWED_HOSTS is set to allow connections from any hosts. -Groups have to be initialized with the following command: -```sh - $ python manage.py init_groups -``` - ## Database -You can run migrations with : +You can run database migrations with : ```sh $ python manage.py migrate ``` +Groups are initialized with the following command: +```sh + $ python manage.py init_groups +``` + You can seed the database with a provided fixtures located in apps/rp/fixtures/all_articles.json: