grepme / cmput410-project

This is our project. WIP.
Apache License 2.0
0 stars 0 forks source link

CMPUT 410 Project

Build Status

A base example of a social network.

Do I Need Vagrant?

No.

python manage.py runserver

Go to town, work from localhost. You may run into issues with a different environment and MySQL if we choose to migrate. You have been warned.

Requirements

If you are not using Vagrant, you'll also need to run this:

pip install commonmark
pip install pillow
pip install beautifulsoup4
pip install feedparser
pip install django

External Tests

Runs using nosetests

Required to have nose tests installed

This runs our server against our own server (Testing the api)

nosetests tests

Vagrant Installation

Download and install Vagrant

Make sure you have Vagrant 1.7.2

vagrant version

Install vagrant-omnibus and put the virtual machine online. It can take up to fifteen minutes to download and install all the packages.

vagrant plugin install vagrant-omnibus
vagrant up

The provisioning can take awhile to install, but once done, project is viewable on localhost:8080.

All changes on your local machine update in real-time on the virtual machine!

HTTP Base Auth

Basic Auth should not be considered a secure way of storing user's passwords, but it is apart of this spec. You can add additional to the api_password_file to access /api with:

htdbm -bm -TSDBM /vagrant/api_password_file <username> <password>

For debug purposes, the default username is set to "node" with the password "api" for anything on the URI /api. ie. http://localhost:8080/api

Important Tips

Github Pages

Our API can be found at: http://grepme.github.io/cmput410-project

Other Contributions