karthikrao5 / inventorymanagement Goto Github PK

View Code? Open in Web Editor NEW

0.0 3.0 0.0 1.53 MB

GT Junior Design Part 2 Spring 2017

Shell 2.14% PHP 43.73% ApacheConf 11.11% HTML 14.77% Ruby 1.12% JavaScript 22.45% CSS 4.68%

inventorymanagement's Introduction

InventoryManagement

GT Junior Design Part 2 Spring 2017 (CS 3312/LMC 3431 - JIA)

Team 154 - Karthik Rao, Will Christian, Joe Sadler, Andres Littig, Byung Kang

Release Notes v1.0.0

New features for this release:

Bug fixes: None - initial release.

Documentation

Known bugs and defects for Front-end:

Equipment Type and Equipment Edit fields are not removed from updated items array if they are edited and set back to empty. In other words, if you were to type a new updated comment in the form and you didn't want to save the update, there will be an empty string for that key in the updated items array so when submit is hit, it will set the comment to an empty string in the database (ie. "").
Loans page for a user does not have an option to select a due date.

Known bugs and defects for Back-end:

Backend access routes are fragile due to lack of input validation.
API key feature is not implemented in this release.
Log information is missing username (action_by) and how the route is accessed (action_via).
Loan due date expiration is not checked.

Installation Guide

Getting started with this project:

Install CentOS 6.8 on the server.
Clone this repository.
Run

./setup.sh

in scripts/centos/ directory. Make sure that the script has execute permission chmod 777 setup.sh.

./move.sh

in the repository

Visit http://localhost/ (if accessing from the server) or http://server_url/ to use InventoryManagement system.

Or alternatively, use Vagrant to setup development virtual machine automatically and use it.

Getting started with Vagrant:

Download Vagrant box 'centos-6.8-x86_64.box' from provided private Google Drive link (will be emailed to you).
Install Vagrant. https://www.vagrantup.com/docs/installation/
Open terminal and change directory to where 'centos-6.8-x86_64.box' is located.
Run 'vagrant box add centos-6.8-x86_64 centos-6.8-x86_64.box' from terminal to add the custom Vagrant box.
Clone this repository to host (not in Vagrant virtual machine) and move into 'vagrant' directory. You should have 'Vagrantfile' file (without extension).
Run 'vagrant up' to create new virtual machine. You may see warning as virtual machine is being created and provisioned. Depending on your network speed and computer horsepower, this step can take up to 15 minutes.
Once 'vagrant up' is done, you can run 'vagrant ssh' to ssh into the virtual machine. It shouldn't ask you for username and password. If for some reason, vagrant ssh or any sudo commands asks you for password, use 'vagrant' as password for both 'root' and 'vagrant'.
This repository is automatically cloned into the virtual machine in '/home/vagrant/shared/InventoryManagement'.
You should be able to connect to 'http://localhost:8080' to use InventoryManagement system.

Notes: Vagrant maps host port 8080 to virtual machine port 80. Make sure host port 8080 is not in use.

inventorymanagement's People

Contributors

Watchers

inventorymanagement's Issues

Add create cron entry from backend for update functions

Configure plugins/hooks by attribute

As a system administrator, I want to be able to configure plugins/hooks with regard to attribute values to which they apply, attribute values it can provide, the frequency of automated refreshes, if it support a “get all” and the attribute value range it does so over, if the IT admin can preform an on demand refresh, and call information (executable + params OR URL + auth).

Generate user report

As an IT administrator, I want to generate a report of user so that I can use it as an official record.

Define default attribute values

As an IT administrator, I want to define some attribute values which will be default (but overridable) for new searches I run.

Equipment Tracking/CRUD Epic

Surplussed or Trash

As an IT administrator, I want to mark exisiting equipment in the system as ‘surplused’ or ‘trash’ so that it is no longer seen by default search parameters (but can still be located) (IT admin #4)

Edit equipment status

Set attribute display order

As an IT administrator, I want to configure a preference of the order in which attributes should be displayed for my views.

View summary of equipment information

As an IT administrator, I want to view a summary of the current equipment information as well as a complete history of every change over time by date and with the actor making the change.

Add hooks

As a system administrator, I want to add plugins/hooks so that the inventory system can take action on third party services when changes are made to a piece of equipment in the inventory.

Equipment log entry

As an IT administrator, I want to add an equipment log entry so that I can update the equipment history. (IT admin #6)

Email for returned loans

As a renter, I want to receive an email when equipment I had on loan is returned in the system.

Create Users collection in DAO/CoreServices

Getting more done in GitHub with ZenHub

Hola! @bkang61wk has created a ZenHub account for the karthikrao5 organization. ZenHub is the only project management tool integrated natively in GitHub – created specifically for fast-moving, software-driven teams.

How do I use ZenHub?

To get set up with ZenHub, all you have to do is download the browser extension and log in with your GitHub account. Once you do, you’ll get access to ZenHub’s complete feature-set immediately.

What can ZenHub do?

ZenHub adds a series of enhancements directly inside the GitHub UI:

Real-time, customizable task boards for GitHub issues;
Multi-Repository burndown charts, estimates, and velocity tracking based on GitHub Milestones;
Personal to-do lists and task prioritization;
Time-saving shortcuts – like a quick repo switcher, a “Move issue” button, and much more.

Add ZenHub to GitHub

Still curious? See more ZenHub features or read user reviews. This issue was written by your friendly ZenHub bot, posted by request from @bkang61wk.

Attribute display substitution

As an IT administrator (with appropriate permissions), I want to be able to configure an attribute field to display based on a substitution of the stored value. For example, changing a ticket number into a linked URL to open the ticket in its web interface, or the same for a PO number. (IT admin #15)

Hooks/plugins for querying user info

As a system administrator, I want to define a plugins/hooks so the inventory system can query user attribute values.

Edit Equipment

As an IT administrator, I want to modify existing equipment data so that I can fix or update existing equipment status. (IT admin #5)

Edit existing equipment

As an IT administrator, I want to modify existing equipment data so that I can fix or update existing equipment status. (IT admin #5)

See list of equipment user is responsible for

As a property coordinator, I want to see the list of equipment that I am responsible for by their type, renter, department, and other categories so that I can check their status and location.

Search for equipment

As an IT administrator, I want to search for existing equipment in the system by any AND/OR collection of attribute values, and for each of the values to be able to specify ‘<,>,<=,>=,==,!=,contains,before,on,after’ as appropriate for the attribute type.

Add Api key controller

add the api key controller that receives input from user that includes the master key

Make bulk changes

As an IT administrator, I want to be able to preform a bulk change to a set of entries identified by search (re: RT bulk update).

See detailed info about equipment status

As a property coordinator, I want to see detail information and status of the equipment so that I can use that data to do my job.

Request rent extension

As a renter, I want to be able to request an extension of a loaned equipment individual and in bulk after acknowledging agreement with a policy.

Add API key validation/routes

Set renewals to automatic

As an IT administrator, I want to be able to designate loans for which renewals are automatically granted. Refer to Renters #4.

Add hook actions to log

As a system administrator, I want both inbound and outbound plugins/hooks to be able to log to the inventory system in general and into the change log for the relevant piece of equipment such that the latter can be visible to IT administrators.

View equipment log

As an IT administrator, I want to view the equipment log so that I can audit the equipment history.

Add entry to equipment log

an IT administrator, I want to add an equipment log entry so that I can update the equipment history. (IT admin #6)

Create API key Collection in DAO/CoreService

Delete entries

As an IT administrator, (with appropriate permissions), I want to be able to delete entries. (IT admin #18)

Define help text for attribute field

As an IT administrator (with appropriate permissions), I want to define help text for an attribute field to display in a suitable manner on the view and update pages for equipment.

Send reminders for loan due dates

As an IT administrator, I want to be able to automatically send out reminders about loan due dates.

Generate equipment report

As an IT administrator, I want to generate a report of equipment so that I can use it as an official record.

Add equipment

As an IT administrator, I want to add new equipment to the system so that it can be tracked by the system. (IT admin #3)

Sprint 1

Move code to production server to test CAS Auth

Add attributes to equipment types

As an IT administrator (with appropriate permissions), I want to be able to add single and multiple value attribute fields to be included in one or more types of equipment, with those fields being one of: a boolean, a string (with optional regex validator), and enumerated set of options, an integer, a dollar value, a date, or a text box.