Skip to content
This repository has been archived by the owner on Oct 28, 2019. It is now read-only.

Latest commit

 

History

History
62 lines (40 loc) · 3.23 KB

README.md

File metadata and controls

62 lines (40 loc) · 3.23 KB
Raw

CalChart

An attempt at a web-based redesign of Calchart, which integrates the desktop Calchart application, the viewer, and the server.

Goals:

  • Create a cloud file system that stores shows created by Stunt and can be viewed by bandsmen
  • Create an intuitive UI for charting shows
  • Integrate Calchart Viewer
  • Integrate the individual continuity generator

For a visualization of the design, see the Figma.

Setup

This project is different from other Comp-Comm projects in that developers will be running the Django server and building the static files locally instead of in a virtual machine (with Vagrant). Each of the steps below will list out the requirements needed to install on a developer's computer.

Python 3.6

Our Django code is using Python 3.6, which can be downloaded either with Conda or from source.

Conda provides a lot of cool features (we only use a fraction of these features), such as supporting user-wide virtual environments, allowing for different Python versions in each environment, and more.

Recommended install (Conda):

  1. Install Conda here (for Python 3.6)
  2. Create a virtual environment: conda create --name calchart
  3. Activate the environment (needs to be run in every shell): source activate calchart
  4. See documentation for more details.

Install from source:

  1. Install Python 3.6 here
  2. Create a virtual environment: python3 -m venv venv
  3. Activate the environment (needs to be run in every shell): source venv/bin/activate

Node.js

Most of the code in this project is written using Vue, a Javascript framework for building client-side applications. In order to run and build this code, developers need to install Node 9 and Yarn. For MacOS developers who use Homebrew, brew install yarn should install both dependencies.

After installing Node, run yarn install to install the dependencies.

Django

After finishing all the above installation steps, do the following:

  1. Install Django requirements (inside the virtual environment): pip install -r requirements/dev.txt
  2. Set up Django database: python calchart/manage.py migrate
  3. Create a super user: python calchart/manage.py shell < scripts/createsuperuser.py

Development

First, get the Django server running: python calchart/manage.py runserver. Then, in another tab, run yarn start.

You should now be able to connect to http://localhost:5000.

Testing

This project contains four testing facilities:

  1. Linting (yarn lint and flake8 calchart/): Checks code style
  2. Server-side tests (python manage.py test): These are Django tests that test functionality within the back-end; e.g. testing Django models
  3. Unit tests (yarn test): These are Javascript tests (using the Mocha library) that test functionality within the front-end; e.g. testing Component methods
  4. End-to-end tests (yarn cypress): These are tests that test functionality between the back-end and front-end; e.g. testing sendAction calls.

More detailed information and examples of these tests can be found in docs/Testing.md.