Skip to content

Latest commit

 

History

History
108 lines (73 loc) · 3.8 KB

README.md

File metadata and controls

108 lines (73 loc) · 3.8 KB
Raw
MIT-Tab

CircleCI codecov Documentation Status

Deploy to DO

MIT-Tab is a web application to manage APDA debate tournaments.

Looking to learn how to use mit-tab? Check out the docs! It has articles on everything you need to know to run tournaments efficiently. This README is for people who intend to develop features for the software, refer to the documentation linked above for non-development-related information

Local Installation + Running

Currently the installation consists of downloading the code, installing requirements and then manually running the server.

Pre-Requisite: Install MySQL

Instructions for this will vary by platform. On Mac OS X, it comes pre-installed.

Otherwise, check here for Windows and here for Linux

Before running, you need to install MySQL and create a database called mittab

The database login credentials can be configured through the following env vars:

  • MYSQL_USER (default root)
  • MYSQL_PASSWORD (default "", if you use the default make sure you allow empty root passwords in your mysql settings)
  • MITTAB_DB_HOST (default 127.0.0.1, you probably have no need to change this)
  • MITTAB_PORT (default 3306, the default mysql port)

Running the server

git clone <mit-tab repo>
cd mit-tab

# make sure to use python3 for the virtualenv
pip install pipenv
pipenv install

# set-up webpack assets
npm install

# load test data. username: tab password: password
pipenv run python manage.py loaddata testing_db

# Simultaneously runs webpack and the python server
pipenv run ./bin/dev-server

Note: the bin/dev-server script is new and not tested on many set-ups. If you have any issues, you can accomplish the same thing by running:

# build the assets:
/node_modules/.bin/webpack --config webpack.config.js

# ...or, instead, open another terminal tab and watch the
# assets to auto-update with changes
/node_modules/.bin/webpack --config webpack.config.js --watch

# run the Django server:
pipenv run python manage.py runserver

Testing

To run the tests, you will need to have chrome's headless driver installed and in your $PATH. Info here

Optional: Running with Docker

If you'd like, you can also run the application with Docker. The docker configuration is meant to simulate a production server, so it's not ideal for debugging or general development. You must have docker-compose 1.14.0+ installed to run.

To run on localhost Since it uses nginx, it doesn't need a port in the url. Just go to http://localhost

docker-compose build
docker-compose up

# sets up the static files
docker-compose run --rm web ./bin/setup password

Production Setup & Deployment

Deployment to production is controlled by benmusch/mittab-deploy. The production environment is built using the dockerfiles in this repo, and the tournaments automatically pull the code that is currently on the master branch.

Older versions of the production setup are documented here.