texaslan.org

The main online hub for Texas LAN, built with Django. This project is heavily based on this project here

• User system
• Event system with QR code check-in
• URL shortener
• Admin panel
• Information about LAN

Development

Local Deployment

Docker Compose will handle it for you.

docker-compose up

This will spin up a database container, apply migrations to the database, load test data, and run the application.

Development operations

Running operations on the Django application. Use this for importing fixtures, or any administrative tasks afforded by manage.py.

$ docker exec -it texaslan_web_1 bash

Running SQL operations on the Postgres instance, such as querying, updating, and deleting rows in the database.

$ docker exec -it texaslan_db_1 bash
$ su - postgres
$ psql

All included test users have the password password.

Running Tests

Run

py.test

Checking Coverage

To run the tests, check your test coverage, and generate an HTML coverage report

coverage run manage.py test
coverage html
open htmlcov/index.html

Manually manipulating data

To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. In the local environment, check your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

To mark an existing account as superuser and staff

psql texaslan
texaslan# UPDATE users_user SET is_superuser = true AND is_staff = true WHERE id = 1;

Server Deployment

First time

Ensure that Python 3.5 and Postgres are installed, then run the below.

git clone git@github.com:texaslan/texaslan.org.git
pip3 install -r requirements/production.txt
npm install
npm install --global gulp-cli
createdb texaslan
python3 manage.py migrate

Install a Django stack on a DigitalOcean Droplet. You will need more than the base droplet as 512Mb of RAM is too little to install everything.

Get SSL certificates from Let's Encrypt, and configure Nginx to serve them. You can follow this tutorial on how to implement this on this Django stack.

Rename config.template.json to config.json in config/settings. The Django key should be a unique 50 character key. You can generate a new key here: http://www.miniwebtool.com/django-secret-key-generator/. Make sure that you generate or retrieve the other keys as well.

Updates

The LAN server is configured with an updatelan command, which is an alias for the below.

# Update and use master ( not pull, to enforce using whatever is on master )
git fetch
git reset --hard origin/master

# update pip & python packages
pip3 install --upgrade pip
pip3 install -r requirements/production.txt

# update nodejs packages
npm install

# migrate database changes
python3 manage.py migrate

# Update sass and js files
gulp

# Gather all static files and update them
python3 manage.py collectstatic --noinput

# Restart server with new code::
sudo systemctl restart gunicorn && sudo systemctl restart nginx