You are on page 1of 14

Wines Elementary School Event Volunteer and Proposal Management System

           

User Manual & Installation Guide

SI 572 Database Application Design Final Project
Tze-Hsiang Lin, Lei Shi, Weihua Wang, Peggy Wong

Table of Contents
User Manual ...........................................................................................................................................1
General Users ...............................................................................................................................1 Parents ............................................................................................................................................1 Site Administrators .....................................................................................................................2 Teachers .........................................................................................................................................3

Installation Guide ..............................................................................................................................4
1 Introduction ..............................................................................................................................4 1.1 Purpose of this document ..................................................................................4 1.2 Contact Information .............................................................................................4 2 Current Hosting Site Name ..................................................................................................4 3. Installing the system .............................................................................................................4 3.1 Set up Running Environment ...........................................................................4 3.2 Create and Import Database .............................................................................7 3.3 Import software code into web server ..........................................................8 3.4 Run ..............................................................................................................................8 4. Guidance for developers .....................................................................................................9 4.1 Set up Development Environment .................................................................9 4.2 Framework ........................................................................................................... 10 4.3 Structure of the code ........................................................................................ 10 5. Troubleshooting .................................................................................................................. 10 5.1. Cache model ....................................................................................................... 10 5.2 Database Privilege ............................................................................................. 11

User Manual
General Users (For all role types)
Goal#1: User Profile Management Goal#1.1: Setup Username Pre-condition: The user logs in with original system generated account. Step 1: Sign in account Step 2: Click on [My Account] > [My Profile] Step 3: Input desired username in text field: “Input a username” Step 4: Click [Setup this USERNAME] button Goal#1.2: Edit Profile Information Step 1: Sign in account Step 2: Click on [My Account] > [My Profile] Step 3: Click on [Edit Profile] button Step 4: Edit profile information Step 5: Click on [Save] button Goal#2: View Volunteered/Coordinated Events Step 1: Sign in account Step 2: Click on [My Account] > [My Events]

For Parents
Goal#1: Event Sign-up Step 1: Sign in with child’s student account Step 2: Navigate to “Profile” area Step 3: Select Parent name from selection list: “Parents” Step 4: Click on [Volunteer Sign-up] > [Event Calendar] Step 5: View calendar for event Step 6: Click on an event Step 7: Navigate to pop-up window: “Volunteer Sign-up” Step 8: View event description in “Sign Up Today” area Step 9.1: If wish to sign-up: Step 9.1.1: Click on checkbox: “Yes! I want volunteer for %event name%”

   

Step 9.1.2: Click on [Submit] button Step 9.2: If do not wish to sign-up: Step 9.2.1: Click on [Cancel] button Goal#2: View Event Information Step 1: Sign in with child’s student account Step 2: Navigate to “Profile” area Step 3: Select Parent name from selection list: “Parents” Step 4: Click on [Volunteer Sign-up] > [Event List] Step 5: View list of all events Step 6: Click on [%event name%] hyperlink Step 7: View event information Goal#3: View Volunteered Events Step 1: Sign in with child’s student account Step 2: Navigate to “Profile” area Step 3: Select Parent name from selection list: “Parents” Step 4: Click on [My Account] > [My Events]

For Site Administrators
Goal#1: User information creation Goal#1.1: Create individual user data Step 1: Sign in as Administrator Step 2: Click on [Admin]>[User Management] Step 3: Navigate to “Basic User Management” > “Create A User” area Step 4: Fill in user information in text field: “Last Name”, “First Name”, “ Email” and “Phone” Step 5: Choose “Role” from selection list Step 6: If “Role” is a Teacher or Student, fill in a grade in text field: “Grade” Step 7: If “Role” is a Parent, add a child by selecting child name from the list: “Add Children” Step 8: Click [Create this user] button Goal#1.2: Define user relationship Step 1: Sign in as Administrator Step 2: Click on [Admin]>[User Management]

   

Step 3: Navigate to “User Relationship Management” > “Parent-Student Relationship” Step 4: Select Parent and Student from selection list: “Select Parent & Student” Step 5: Click on [Create this Relationship] button Goal#2: User account creation Step 1: Sign in as Administrator Step 2: Click on [Admin]>[User Management] Step 3: Navigate to “Account” > “Create An Account” > “Select a User” Step 4: Select a user from selection list: “Select a User” Step 5: Click on [Create & Send an email] button Goal#3: Create Event Step 1: Sign in as Administrator Step 2: Click on [Admin] > [Event Management] Step 3: Navigate to “Event Management” > “Create a new event” Step 4: Select an event coordinator from selection list: “Event Coordinator” Step 5: Fill in an event title in text field: “Event Title” Step 6: Fill in event description in text area: “Event Description” Step 7: Select Start Date & End Date from pop-up calendar Step 8: Select event type from selection list: “Event Type” Step 9: If the event is a event for a specific grade: Step 9.1: Select checkbox: “Grade Event” Step 9.2: Fill in grade in text field: “Grade Event” Step 10: If event is created from a proposal: Step 10.1: Select checkbox: “From Proposal?“ Step 10.2: Select a proposal from selection list: “From Proposal?” Step 11: Click on [Create this EVENT] button

For Teachers
Goal#1: View Coordinated Events Step 1: Sign in as Teacher Step 2: Click on [My Account] > [My Events]

   

Installation Guide
1 Introduction
1.1 Purpose of this document The purpose of this documentation is to provide installation guide for developers and system administrator to install our event management and sign-up system for wines elementary school. 1.2 Contact Information If you have any question about this documentation, please contact Colleen Van Lent at colleenvanlent@gmail.com.

2 Current Hosting Site Name
If you want to have an idea of what the system looks like before installing it in your own computer, please visit the link below to see our online version: http://www.micuby.com/wines/ Please contact Colleen to get a test account and password.

3. Installing the system
3.1 Set up Running Environment In order to run the software, you need to have a web server that supports PHP running in your local computer. Here we provide two solutions. The first one is easy and highly recommended for all users; the second one is for professional programmers.

   

Solution 1: use XAMPP or MAMP XAMPP and MAMP are two easy-to-install distributions containing both MySQL and PHP. To install them you only need to download their source code and unzip in your local machine. Please see the following for detailed steps: Step 1: Download Download XAMPP from: http://www.apachefriends.org/en/xampp.html Unzip the downloaded file into your preferred directory. Double-click xamppcontrol file to open the control panel. Enable Apache and phpMyAdmin. Step 2: Test Test of successful web server installation Now open any browser and enter http://localhost/, you should see the following web page:

Figure 1: successful running of Apache

   

Test of successful MySQL installation Enter localhost/phpMyAdmin/. You should see the web page as shown in Figure 2.

Figure 2: successful running of MySQL If you use a Mac OSX development environment please use MAMP instead of XAMPP, you can download it from: http://www.mamp.info/en/index.html Steps to installation and testing are the same as XAMPP.

Solution 2: Configure your own web server and PHP environment You can choose to install your preferred web server that supports PHP5 and install PHP5 development environment. Here are some links that might be useful: Apache web server: http://www.apache.org/ PHP: http://www.php.net/

   

3.2 Create and Import Database Step 1: Open any browser and enter http://localhost/phpMyAdmin/ to open the database management panel. Step 2: Create a new database named “wines”. Step 3: Add a new user with the user account “wines”, password “wines” under the “Privileges” menu. For your personal preference, you can choose your own account, and modify the configuration files in the code as stated in next section (We strongly recommend you choose your own account and password for safety issue). Step 4: Click the link named “wines” in the left panel to enter the database you just created. Open the attached wines.sql, copy and paste the SQL commands into the SQL command window. Now you should be able to see all of the tables in the left side as shown in Figure 3.

Figure 3. Successful import of database

   

3.3 Import software code into web server. If you are using XAMPP or MAMP, now unzip the attached file wines.rar into the following directory: “xampp/htdoc”. If you chose your own database account and password, change the configuration file in “wines/application/config/database.php”. Replace “wines”, “wines” with your own account and password. Make sure the account and password are consistent with the one you created for your database in 3.2. If you configured your own web sever instead of using XAMPP or MAMP, please refer to your server manual to put code in the correct directory. 3.4 Run Open your browser and enter “http://localhost/wines”, now you should see the following homepage.

Figure 4. Successful installation of the system

   

Your installation is successful now! You can log in with the existing account as shown in the account table and admin tale in the database. Try to log in with different roles (student, teacher/staff, or administrator) to see different views of the web pages.

4. Guidance for developers
After you installed the system successfully, if you want to do further development based on current system, please read this section carefully. 4.1 Set up Development Environment First of all, you need to download your code editor and SVN control tools. We recommend using Eclipse for PHP developers and Subclipse for version control. Eclipse Download Eclipse from: http://www.eclipse.org/downloads/ Choose the one for PHP developers, then unzip the downloaded file into any directory you prefer. Subclipse Subclipse is an svn plug in for Eclipse. You can download and install subclipse according to the installation guide provided below: http://subclipse.tigris.org/servlets/ProjectProcess?pageID=p4wYuA

   

4.2 Framework Our system is developed based on Kohana – a light-weighted MVC PHP5 framework. Please refer to their online documentation for details in your development work. Below is the link of Kohana’s documentation: http://kohanaframework.org/guide/about.kohana

4.3 Structure of the code Our code is mainly divided into three parts: Model, View, and Control. All of the model files are related with database manipulation and located under “application/classes/model”. All of view files are for client-side rendering and located under “application/views”. All of the controllers are responsible for the back-end control and located under “application/classes/controller”. Other static files including javascript and css are located under “static/js” and “static/css” folders.

5. Troubleshooting
5.1. Cache model If you got an error saying, “Directory APPPATH/cache must be writable” as shown in Figure 5, this means that the cache folder is not allowed to write in your local computer. This problem is usually common in Mac where the default privilege of folders under application is “Read Only”. To solve this problem, adjust the privilege of the cache folder so that the code can store temp files in that folder.

   

10 

Figure 5. Cache problem 5.2 Database Privilege If you encountered an error saying “Access Denied” as shown in either (a) or (b) in Figure 6, this means your account or password in your connection code is different from the one in your database privilege. Please refer to section 3.2 for this problem.

(a) Cannot log in

   

11 

(b) Can log in but access to user information denied Figure 6. Database privilege problem

   

12