Starting the software
The software can be run by entering the URL into a browser. For a local deployment, refer to the developer documentation.
To access our current deployment located here, you can sign in with the "admin", "staff", or "volunteer" usernames. To make our demo environment easily accessible, we set the password for each to be "password". The admin can change the passwords for all 3 accounts in the "ADMIN SETTINGS" page.
Using the software
There is an intuitive user interface that will allow users to create, read, update, and delete entries in the inventory. A tutorial for using the software can be found here.
The Table
The table shows all the current products in the inventory.
- By clicking the arrow on the right side of a product you can view more info about the product.
- The table can be filtered by the menu on the left of the page as well as the banner along the top of the page.
Creating New Products and Categories
In the upper left corner, you are able to create new products and categories.
Categories
- A new category is created by pressing the "NEW CATEGORY" button.
- NOTE: In order to make a product, you must first have a category to put the product in!
- Once in the new category menu, name your category and select a color and icon.
Products
- A new product is created by pressing the "NEW PRODUCT" button.
- Once in the new product menu, fill out the form to add the product..
Product Page
The product page is where you can edit and interact with a specific product.
- Click on the camera icon in the upper left corner to add or change the product image.
- The "SET INVENTORY" button can be used to change the total inventory of the product.
This can be used while taking stock to input the total amount of stock. - The "ADD INVENTORY" button is used for adding new items for a product.
In this menu the input amount is added to the total stock.
This is where you specify if a product was purchased or donated. - In both the "SET INVENTORY" and "ADD INVENTORY" menus, you can add stock units. You can create as many units as you like. For example, there is an individual unit that contains 1 individual unit. You can then create a "Box" unit that contains 20 individual units.
- The "..." next to ADD INVENTORY is where you can update information about a product and permanently delete the product
Logging in
You can log in as an admin, staff, or volunteer. Reach out to your administrator to obtain the proper credentials. The admin can change the passwords for all 3 accounts in the "ADMIN SETTINGS" page.
Email Notifications
In order to receive email notifications, the admin should click the "ADMIN SETTINGS" button in the top right corner of their screen and type in their email address. Then, email notifications will be sent whenever a product's inventory reaches 50% and 25% of the ideal stock.
Exporting the inventory data to a CSV
The application allows users to transform the inventory data into a CSV file. The button to perform this action is located on the REPORTS page.
Reporting a bug
Problems can be reported by making a GitHub issue here.