README.md 969 Bytes
Newer Older
Sandro Lutz's avatar
Sandro Lutz committed
1
# Burger-Tool (AMIV Anniversary 125 years)
Sandro Lutz's avatar
Sandro Lutz committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

A Webapp to select the most popular burger as AMIVs 125 year anniversary burger.

## Setup

### Virtualenv

The website runs using flask, and we recommend running it in a virtual
environment. To do this, you first need to initialise it:

```bash
\$ virtualenv venv
```

This will initialise the virtual environment in the `venv` directory. To
activate it, source the following script:

```bash
\$ source venv/bin/activate
```

If that was successful, your `$PS1` should start with `(venv)`.

### Dependencies

Now you need to install the dependencies listed in `requirements.txt`.

```bash
\$ pip install -r requirements.txt
```

### Database & Admin User

To create the database structure and add an admin user, run
```bash
\$ ./setup.py <admin_username> <admin_password>
```
## Run
After that, you can run the website by executing `amiv-anniversary125-burger-tool.py`. The website is
served at `127.0.0.1:5000` by default.