Skip to content

austinglaser/csci3308-project

Repository files navigation

Project for CSCI 3308

Outletify

Outletify is the simplest way to manage and monitor all the household technology you depend on. Lower your bills, reduce your environmental footprint, and make your life easier by leaving menial tasks to the machines.

Repo Organization

doc/

Contains a project description, and is also where auto-doc output goes

ENV/

Contains the Django/server environment

part1_src/

Contains source for the Part 1 pdf

Part3_Excel_UAT/

Contains User Acceptance Test template for Part 3

part3_src/

Contains source for the Part 3 pdf

sensor/

Contains source that runs on microcontrollers ("sensors", which monitor power usage and run automation tasks)

server/

Contains source for a lightweight uwsgi server that handles simple logging requests

uwsgi-2.0.11.2/

Contains source for uwsgi

Doxyfile

Configuration file for Doxygen

Makefile

Provides commands which work on the entire project:

make

make clean

make dep

make test

make doc

Outletify_Part_1.pdf

Part 1 submission

Outletify_Part_3.pdf

Part 3 submission

README.md

This file

run_tests

Runs all tests. Invoked by "make test"

run_server

Runs the Django server

Installation

git clone https://github.com/austinglaser/csci3308-project.git
cd csci3308-project
make dep
make

Running the Server

./run_server

Running Tests

make test

Generating Docs

make doc

Documentation is stored in doc/html and doc/latex