Giter VIP home page Giter VIP logo

tutorsapp's Introduction

Build Status

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

tutorsapp's People

Stargazers

avatar avatar avatar avatar

Watchers

avatar avatar

tutorsapp's Issues

Backend testing

Нужно написать тесты для всех приложений Django в модуле backend. Желательно покрыть ими каждый view.

Limitations on vacancies

It's not very nice when a user can create vacancies (even duplicates) without any limitation. Must be fixed on the backend

vk-apps-frontend testing

На данный момент написан тест для отрисовки всего приложения. Но он не срабатывает по некоторым причинам, связанным с использованием библиотеки VK UI. В процессе попытки исправления заметил, что утилита @vkontakte/create-react-app не создаёт стандартного для React-приложений тестов и видимо разработчики в курсе об этой проблеме. Однако от этого проблема тестирования модуля не решена

Frontend views

  • LessonEdit
  • LessonCreate
  • UserVacancies
  • VacancyEdit
  • OutgoingStudentRequests
  • Tutors
  • Students
  • MoneyTransfer

Errors handling on a frontend

  • Mark invalid fields in forms
  • Mark a non-field errors
  • Error messages localization
  • Handle 500-like error (processing based on status)

README update

Нужно обновить инструкции по запуску и обновить информацию о некоторых переменных окружения

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.