ProgrammingLanguageLeader / TutorsApp

VK Apps service

Tutors App

An application for convinient interaction between tutors and students

Structure

• backend - Django project that provides server API
• vk-apps-frontend - module for the client view of the application in "VK Apps" platform
• docs - the project documentation
• docker - files used by Docker

Running locally using Docker Compose

Running service:

docker-compose up -d

Stopping service:

docker-compose down

Running locally without Docker

vk-apps-frontend

Node.js and NPM are required.

Installation of dependencies:

npm install

Running locally in a development mode:

npm start

Building the module:

npm run build

This module has an apportunity of using Github Pages as a hosting. Set a property homepage in a file package.json to an address on Github Pages. Use the following command to deploy the module via this service:

npm run deploy

backend

Python 3.6 or higher and pipenv are required.

Run the following command to install dependencies and configure virtual environment:

pipenv install

After the installation you need to run database migrations:

pipenv shell
python manage.py migrate

Finally, you are able to launch the backend server:

pipenv shell
python manage.py runserver

If you need to run tests, use these commands:

pipenv shell
python manage.py test

Deployment

Use instructions from a docs/ folder.

License

This project is licensed under the MIT License - see the LICENSE file for details