Oberon

This repo contains the backend for the Villanova Courses platform

Primary Features

Fetches course data from Banner on a schedule Parses Course data and writes the data into a database

Setup Instructions

Install Postgres [OSX for now]

1. “`brew doctor“` to make sure your package manager is running properly
2. “`brew update“` to update brew package links
3. “`brew install postgres“` to install postgresql
4. Read the Caveats (I personally boot psql each time I want to work but you can also setup

background / startup processes. Here’s a good [link for that](https://www.codefellows.org/blog/three-battle-tested-ways-to-install-postgresql))

1. “`which psql“` should match /usr/local/bin/psql
2. Boot by typing “`psql“` in your shell

How to Initialize your DB

1. “`createdb VillanovaCourseDB“`
2. “`createdb TestVillanovaCourseDB“`
3. Now try this “`psql VillanovaCourseDB“` and you should be presented with the CLI for postgres

you can even see your tables and relations by typing “`\d“` in the CLI

<img src=”psqltables.png” width=”400” />

Populate your Database

1. Create an HTML file generated by the response to the post request (from banner)
2. Navigate to the top level directory of the repo
3. Build the database from your HTML file by running the following script
4. “`python setup.py [-filename]“`
5. The database will now include all of the information from the HTML file

Set up the Configurations

1. From the dropbox, retrieve the config and private files
2. Place them into /Oberon/oberon
3. These files are required

Running the Test Suite

1. From the top level of the repo, run the following shell command

“`nose2“`

Run the server

1. Run the run.py script to start the server
2. “`python run.py“`

Recap

1. Install Postgres correctly
2. Create the Database
3. Run the setup.py script and pass the HTML file as the command line argument
4. Run the test suite to make sure the build isn’t broken
5. Run the run.py script to start the server