Skip to content
This repository has been archived by the owner on Apr 6, 2021. It is now read-only.

Update install doc #5

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 17 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,20 +85,27 @@ For the host system we recommend **Debian-based** OS, other distribution are not
* `docker-compose` `≥1.7.0`;
* `Python` `≥3.5`.

### Installation
### Install (for Development)

From developer computer, run:
See [docs/how-to-develop.md](docs/how-to-develop.md).

First configure the network interface to use, _e.g._ `wlp4s0`:

$ export DEFAULT_INTERFACE=${interface:=wlp4s0}

Then build and up containers:

$ make dev

If that's your first run, you will need to setup a [dabatase user](backend/README.md)

$ make first-run

$ cd frontend/
$ npm run build
$ cd ../deploy/
$ archive="$(./create_archive.sh | tail -n 1)"
$ ./send-scripts.sh "$archive"

If you need to setup a python environment, please have a look at our short [Python and virtualenv doc](./docs/how-to-python-and-virtualenv.md).
### Development

See [docs/how-to-develop.md](docs/how-to-develop.md).
### Install (for Production)

Check [deploy/README.md](deploy/README.md).

### Glossary

Expand Down
2 changes: 1 addition & 1 deletion backend/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
wheel
smartconfigparser==0.1.1
https://github.com/guillaumevincent/smartconfigparser/archive/0.1.1.zip
Django==1.9.6
djangorestframework==3.6.1
djangorestframework-jwt==1.8.0
Expand Down
4 changes: 2 additions & 2 deletions makefile
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@ reset-test-env:
docker network prune --force

where-is-front-office:
frontoffice_ip="$$(docker inspect coaxisopt_daemon_1 --format "{{ json .NetworkSettings.Networks.coaxisopt_default.IPAddress }}" | python -m json.tool | sed -s 's/"//g')" \
frontoffice_ip="$$(docker inspect coaxis-opt_daemon_1 --format '{{ $$network := index .NetworkSettings.Networks "coaxis-opt_default" }}{{ $$network.IPAddress}}')" \
&& echo "Front-office → http://$$frontoffice_ip/"
echo
@echo

dev: reset-test-env prepare-env where-is-front-office
echo "Back-office → http://localhost/"
Expand Down