diff --git a/.env.sample b/.env.sample index d777283f3d53ee199cc8f80aebd5e303ef77397b..1fe8f2c962ad278914d465424be0eb94937a1a29 100644 --- a/.env.sample +++ b/.env.sample @@ -1,6 +1,6 @@ COMPOSE_FILE=docker-compose.yml:ports.yml HOST=0.0.0.0 -PORT=5000 +FLASK_PORT=5000 MYSQL_USER=mirador_backend MYSQL_PASSWORD=randompassword MYSQL_ROOT_PASSWORD=otherrandompassword diff --git a/Readme.md b/Readme.md index c036f98abb307835c541b891307541085fba5bee..b1ee65c3715c6a7783ea5bc8b062a0f06cb9f2c2 100644 --- a/Readme.md +++ b/Readme.md @@ -1,10 +1,13 @@ # Mirador backend +## Get the project + +`git clone gitlab@gitlab.tetras-libre.fr:iiif/backend.git && cd backend` + ## Install and run ### local - #### Requirements + virtualenv (optionnal) @@ -12,11 +15,14 @@ #### Dev mode -1. Optionnal create a virtual env `virtualenv venv && . venv/bin/activate` +1. Optionnal create a virtual env : + - `virtualenv venv && . venv/bin/activate` + - OR `python3 -m venv venv && . venv/bin/activate` + 2. Install dependencies `pip install -e .` 3. `cp .env.sample .env` and edit `.env` file to suit your needs 4. Run `flask --debug --app Mirador_backend.app run` - +5. Go to [http://localhost:5000/mirador_resource](http://localhost:5000/mirador_resource) #### Production mode **TODO** @@ -40,6 +46,8 @@ cp .env.sample .env docker-compose up ``` +Go to [http://localhost:5000/mirador_resource](http://localhost:5000/mirador_resource) + #### Test ```