# README #


### Requirements:

The webserver is a python 3.5+ application.

Requires the following python packages, which can be installed using `pip`:

- CherryPy (>=3.7.0)
- Mako (>=1.0.1)
- Markdown (>=2.6.2)
- PyYAML (>=3.11)
- bcrypt (>=2.0.0)

### System setup:

Open a terminal and navigate to a directory where this software is to be installed, e.g. `/var/www` or `/home/username`. 
Run the following commands:

```.bash

cd WHERE/TO/PUT/THE/SOFTWARE

# get software using git
git clone https://USER@bitbucket.org/USER/perguntations.git
cd perguntations

# create database (if no csv file is provided, a database with 5 fake students is created for debugging)
./initdb.py CSV_FILE_HERE
mv students.db SOMEWHERE

# update test configuration with the correct database file.
vi demo/test.yaml
# Edit line 7 to something like
# database: SOMEWHERE/students.db

# edit server configuration if needed
vi config/server.conf

# get help
./serve.py --help 

# run demo test
./serve.py demo/test.yaml

# open browser at http://127.0.0.1:8080/
# the professor/administrator is number 0

# ^C to terminate the server
```

### Troubleshooting

* If you are getting any `UnicodeEncodeError` type of errors that's because the terminal is not supporting UTF-8. Try running `locale` on the terminal and see if there is any error messages. Solutions:
    - debian: fix it with `sudo dpkg-reconfigure locales`, select your UTF-8 locales and try again.

### Contribute ###

* Writing questions in yaml format
* Testing and reporting bugs
* Code review
* New features and ideas

### Contacts ###

* Miguel Barão mjsb@di.uevora.pt