Django project for web experiences

Jérôme BUISINE 548f351bbb Merge branch 'release/v0.1.2' 5 gadi atpakaļ
ThesisWebExpeDjango 1ffcef1620 Update whole application 5 gadi atpakaļ
expe 1ffcef1620 Update whole application 5 gadi atpakaļ
static 1ffcef1620 Update whole application 5 gadi atpakaļ
.dockerignore 8f18f9fa38 Add of dockerignore file 5 gadi atpakaļ
.gitignore 6a0a019eb3 Update of quest expe with load screen 5 gadi atpakaļ
Dockerfile 1ffcef1620 Update whole application 5 gadi atpakaļ
Makefile af1948331d Update clean make commands 5 gadi atpakaļ
README.md 1ffcef1620 Update whole application 5 gadi atpakaļ
__init__.py 1ffcef1620 Update whole application 5 gadi atpakaļ
docker-compose.yml 1ffcef1620 Update whole application 5 gadi atpakaļ
manage.py 58e57f85d6 First project version 5 gadi atpakaļ
requirements.txt 3e21dcc55e Use of docker compose file 5 gadi atpakaļ

README.md

DjangoRecipes

Description

Web site which contains experiences on synthesis images (perception of noise).

Installation

1. Manually

Requirements

You need to have python, pip

pip install -r requirementst.txt

Run server

And then, run the server :

python project/manage.py runserver

or if you want to precise a specific port number :

python project/manage.py runserver 8080

2. Using docker (recommended)

You can use make commands:

make build
make run

Or simply:

make deploy

Will run build and run commands at once.

You also have stop, remove, clean commands:

  • stop: stop current container instance if exists
  • remove: stop and remove container instance if exists
  • clean: remove docker image if exists

Configuration

Create your own admin user:

python manage.py createsuperuser

You can now access /admin/results route with your credentials in order to download experience results.


Configure your own URL prefix using WEBEXPE_PREFIX_URL:

WEBEXPE_PREFIX_URL=experience python manage.py runserver

or using docker:

WEBEXPE_PREFIX_URL=experience make deploy

Using custom API base URL using WEB_API_PREFIX_URL:

WEBEXPE_PREFIX_URL=experience WEB_API_PREFIX_URL=expe/api python manage.py runserver

or using docker:

WEBEXPE_PREFIX_URL=experience WEB_API_PREFIX_URL=expe/api make deploy

How to contribute ?

This project uses git-flow to improve cooperation during the development.

For each feature, you have to create a new git flow feature branch.

Licence

MIT