Thesis-WebExpe-Django/README.md

Django Web expe

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 requirements.txt

Initialize the database with the following command :

python manage.py migrate

Run server

Run the server :

python manage.py runserver

or if you want to make it listen on a specific port number :

python 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

Create your experiences

See DOCUMENTATION.md. This documentation explains how to create your own experience.

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