README

A "getting started" project for CIS 322, introduction to software engineering, at University of Oregon.

What is this repository for?

The objectives of this mini-project are:

• Experience with GIT workflow with separate configuration: Fork the project, make and test changes locally, commit; turn in configuration file with reference to repo. (Project 0 is practice for this part.)
• Extend a tiny web server in Python, to check understanding of basic web architecture
• Use automated tests to check progress (plus manual tests for good measure)

What do I need? Where will it work?

• Designed for Unix, mostly interoperable on Linux (Ubuntu) or MacOS. Target environment is Raspberry Pi. ** May also work on Windows, but no promises. A Linux virtual machine may work, but our experience has not been good; if you don't have a Raspberry Pi in hand yet, you may want to test on shared server ix-dev.

• You will need Python version 3.4 or higher.

• Designed to work in "user mode" (unprivileged), therefore using a port number above 1000 (rather than port 80 that a privileged web server would use)

• Windows 10 note: The new Windows bash on ubuntu looks promising. If you are running Windows 10, please give this a try and let me know if the Ubuntu/bash environment is suitable for CIS 322 develpment.

Assignment

• Fork this repository to create your own repository on Github. (Read the 'git' documentation as needed, and create an account on Github if you don't have one.)

• Clone your repository onto the machine you want to work on.

• Make and test your changes. Use both automated tests (the script in the 'tests' directory) and some manual tests. In addition to your development environment, test on a Raspberry Pi running Ubuntu.

• Revise this README.md file: Erase what is no longer relevant and add identifying information.

  ## Author: Lil (Nancy) Magill , jill@uoregon.edu ##
  

• Copy the skel-credentials.ini file to credentials.ini, then edit it to contain correct information including your github repository URL. credentials.ini should NOT be under version control (exclude it using your .gitignore file)

• Commit and push ALL your changes to github (except those not under revision control)

• Test deployment to other environments including Raspberry Pi. Deployment should work "out of the box" with this command sequence:

  git clone <yourGitRepository> <targetDirectory>
  cd <targetDirectory>
  make install
  make run
  

  test it with a browser now, while your server is running in a background process

  make kill 
  

• Check and revise your "credentials/credentials.ini" file. My grading robots will read this. Be precise. My grading robots are not very good at guessing what you meant to write. Try it with the auto-checker to be sure.

• Turn in the credentials.ini file in Canvas. My grading robots will use this file to access your github repository.

Who do I talk to?

• Maintained by Michal Young, michal@cs.uoregon.edu
• Use our Piazza group for questions. Make them public (anonymous or not as you prefer) unless you have a good reason to make them private, so that everyone benefits from answers and discussion.