Skip to content

Latest commit

 

History

History
176 lines (116 loc) · 3.55 KB

README.md

File metadata and controls

176 lines (116 loc) · 3.55 KB
Raw

Uveb

Uveb is the backend for UWCCSC VR Experience. It is RESTful API.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

This project requires python3.7, virtualenv, pip and mysql.

Installing

These instructions will set up a development version of uveb on your machine.

First clone the repository.

git clone https://github.com/UWC-CSC/uveb.git

After that, create and activate a virtualenv in the repository:

virtualenv venv
. venv/bin/activate

Install the dependencies:

pip install -r requirements.txt
pip install pycodestyle

Start the mysql server:

systemctl start mysqld

Now, set the application exports:

export FLASK_APP=uveb
export FLASK_ENV=development

And start the flask server:

flask run

Now, you can navigate to localhost:5000 and see if there is a response.

Running the tests

You can run the unit tests:

python -m unittest tests/*.py

Coding style

The coding style is pep8. You can run tests with

pycodestyle uveb/*.py tests/*.py

Deployment

Deploying is done as per the Flask Deployment Guide.

First, you need to install wheel.

pip install wheel

Next, to create a .whl file, run:

python setup.py bdist_wheel

This will create a deployable .whl file in dist/.

These are the releases that are hosted on GitHub releases.

Serving

To finally serve everything, create a folder for the software:

mkdir uveb/
cd uveb/

Download the latest .whl to your server.

Create a new virtualenv by running:

virtualenv venv
. venv/bin/activate

Finally, run pip install uveb-x.x.x-none-any.whl, where x.x.x is the release version.

Also, do not forget to export FLASK_APP=uveb.

uveb is now installed, but you need to setup a database with which it can interface.

This is relatively simple, using the available schema.sql create a MySQL database:

Lastly, but probably most importantly, you have to configure uveb:

sudo mkdir /etc/uveb
sudo touch /etc/uveb/uveb.conf
sudo nano /etc/uveb/uveb.conf

Your uveb should work now, but you haven't installed mysql on your server just yet. We recommend you use mariadb, just because it's more sensible.

Go ahead and install yourself a mysql implementation, set it up, etc.

Then, create a user for uveb:



Configuration


The configuration follows the Microsoft INI format. Currently the only
section available is [Database].


[Database]
username = yourusername
password = yourpassword



Built With



Versioning


We use SemVer for versioning. For the versions available, see the tags on this repository.


Authors


    

  • Marko Vejnovic - Initial work -
    • 



See also the list of contributors who participated in this project.


License


This project is licensed under the
GPLv3 license. Check the
LICENSE file for more information.


Acknowledgments


    

  • Just PurpleBooth
for her more-than-excellent README template.
    •