Skip to content

mavagio/zeeguu-exercises

Repository files navigation

An adaptive online language practice platform

Build Status Coverage Status Dependency Status NSP Status Documentation Coverage

Running locally

First clone the repository from https://github.com/martinavagyan/zeeguu-exercises.git

Front-end

The front end uses Node.js. Referer here for further directions https://nodejs.org/en/download/. After the installation of Node.js was successful, navigate to the project folder and run:

npm install
npm run build

If the installation was successful all the necessary files should be created.

Back-end

Note: you need to have python 3.6.1 installed, on your machine. The back end uses Flask Framework. The following tutorial shows, how to set up virtualenv and Flask:
http://flask.pocoo.org/docs/0.12/installation/

Note: to install virtual, enviroment on windows run:

pip install virtualenv

To install the virtual environment for the project, navigate to the folder and run:

virtualenv < name of the folder>

After installing virtual environment on the project folder, activate it using:

venv/Scripts/activate

Make sure the environment is activated before proceeding with the instructions.

Install all dependencies from requriments.txt

 pip install -r requirements.txt

In case you add new dependencies, do not forget to update the requirements.txt file

pip freeze > requirements.txt    

A batch file (batchfile.bat) is provided to easily activate the virtual environment and start the localhost, given that all the previous installations are successfully completed. You can access the app via:

http://127.0.0.1:5000/ 

The application will redirect to Zeeguu login page if the cookie for the session is not set yet. To set a test session in the cookies, go to the browser and run :

http://127.0.0.1:5000/debug

This will set a test cookie for local debugging.

Heroku Deployment

The project is deployed on the Heroku server[1]. The deployment is connected to Github repository: https://github.com/martinavagyan/zeeguu-exercises The link to deployed app: https://zeeguu.herokuapp.com/