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

olin/maraudersmap-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Marauder's map

Marauder's map helps students see where other students are on Olin's campus.

This is the start of an attempt to modernize The Marauder's Map @ Olin, an application written between 2008 and 2010 by Andrew Barry and Ben Fischer. It used wxPython, PHP, and MySQL.

This repository is for server development. For client development, see [https://github.com/ohack/maraudersmap-client/](Marauder's Map Client Repository).

About the Server

The original server stack was written in PHP and MySQL. We are attempting to improve and modernize it, using Python, a simple microframework, Flask, and likely MySQL, or perhaps MongoDB, depending on pending design decisions.

In addressing some of the issues of the previous version of Marauder's Map @ Olin, we will strive for

Maintainability

  • Code will be legibile, compliant with PEP8, and commented (using the Sphinx .rst markup syntax)
  • Code will have tests to document its status (using the Python unittesting framework)
  • The actual project will be documented in a way such that it can be extended, replicated, and/or restarted relatively easily

Educational value:

  • Standards and standard libraries will be leveraged where available, i.e. JSON for communication general good practices
  • Made open and involve as many students as possible; perhaps it can be leveraged in future applications?

Setup

Linking in the UI Submodule (required for development and running):

$ git submodule init
$ git submodule update

When first running locally, do:

sudo pip install virtualenv
sudo virtualenv venv --distribute
source venv/bin/activate
sudo pip install -r requirements.txt

Then every time locally running:

source venv/bin/activate

Releases

No releases published

Packages

No packages published