User Manual - TheMathewNorman/RFID-Group-14 GitHub Wiki

23rd of May, 2018

Introduction

The following document will detail the setup and use for the project as it exists on the date stamped at the top of this page. The portal (server) is currently the aspect of the project that contains any functional mechanics.

Installing the server

Requirements

  • A WAMP/LAMP Server. †
  • The RFID-Group-14 Project.
  • An RFID Reader. ‡

† WAMP: Windows + Apache + MySQL + PHP & LAMP: Linux + Apache + MySQL + PHP ‡ The RFID reader is connected the computer viewing accessing the portal. It is used to scan in members' cards.

Installation

  1. Move the contents of Portal into your HTTP server's directory root.

  2. Create a database for the project.

  3. Create a file php/sqlcreds.php and copy the following into the file between PHP tags, changing the fields appropriately for your database. $GLOBALS['server'] = "localhost"; $GLOBALS['user'] = "[Database user]"; $GLOBALS['pass'] = "[Database password]"; $GLOBALS['dbname'] = "[Database name]";

  4. Load the site in your browser. (The login screen is currently not functional, to view the project in its current state please browse to localhost/page/index.php)

Current functionality

The site as it exists as of the data stamped at the top of this page has the following functionality:

  • Members -> Add New
  • Members -> List
  • Members -> List -> Delete
  • Admins -> Add New
  • Admins -> List
  • Admins -> List -> Delete

Login functionality is ready to be added, but we are currently waiting for the client to view the work before it is implemented.

Admins

Adding an Admin

  1. Navigate to Admins -> Add
  2. Fill in the required form fields.
  3. Click "Create Admin".
  4. You should now be directed to the Admins list page, the created Admin should appear at the bottom of the list.

Removing an Admin

  1. Navigate to Admins -> List
  2. Locate the Admin user you wish to delete.
  3. Click the trash icon next to the user.
  4. The user is no longer in the list.

Members

Adding a Member

  1. Navigate to Members -> Add
  2. Fill in the required form fields.
  3. Click into the "Keycard" field and scan the card on the scanner. You may also type strings
  4. Click "Add Member".
  5. You should now be directed to the Member list page, the Member should appear at the bottom of the list.

Removing a Member

  1. Navigate to Members -> List
  2. Locate the member user you wish to delete.
  3. Click the trash icon next to the user.
  4. The user is no longer in the list.