Inventory Portal

An awesome way to keep track of materials!!
Live Site »
Explore the docs »
· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License

About The Project

Hey!! You've found an inventory portal, congratulations. Before you go exploring, here are some things to know:

• This particular portal was developed to handle data about materials used in production at a glass blowing studio. The material types bar and frit refer to the different styles of pigmentation used to augment clear glass, while the metal category holds data about the leaves and foils that are use decoratively on the surface.
• You may notice that some of the buttons are disabled if there is no user logged in. This is because while anyone needs to be able to look up a material to see if there is any in stock, only people with certain privileges should be allowed to update the database. To that end, the record builder and all add/remove/delete functionality from the tables has been disabled unless there is a user logged in.
• You may also notice that there is not much data saved in the portal right now. What you are seeing is a guest version of the portal, feel free to register and build records or update records currently in place. You will not affect any production data.

Here's why:

• Every year, I was in charge of delivering an updated inventory of materials on hand at the studio I worked at. That entailed 5-6 employees taking 5 days to count everything, then another couple days for me to aggregate those numbers into a spreadsheet to send to the office.
• By creating a database that can keep a rolling total of inventory bought and used, a large portion of the labor hours spent counting could be saved.
• By tracking daily usage, we can generate information and reports about how much of a certain material is used in a certain product.

Built With

• NodeJS
• Express
• Handlebars
• Materialize CSS
• Passport JS
• Mongoose
• MongoDB Atlas

Getting Started

In order to run this portal locally:

Prerequisites

1. Node JS
2. Modern Browser

Installation

1. Obtain repo link from Github
2. Clone the repo

   git clone https://github.com/your_username_/CH-inventory.git

3. Install NPM packages

   npm i

4. DATABASE CONNECTION:

• Create database named 'inventory' for local environment
• If hosting, you must create MongoDB Atlas account and configure cluster URI on hosting network

  let MONGODB_URI = process.env.MONGODB_URI || "mongodb://localhost/inventory";

  mongoose.connect(MONGODB_URI, { useNewUrlParser: true, useUnifiedTopology: true  }, (error) => {
    if (!error) {
      console.log("Connected!");
      app.listen(PORT, function() {
        console.log('listening on port ' + PORT + ' db: ' + MONGODB_URI);
      });
    }
    else {
      (console.log('mongoose error: ' + error))
    };
  });

Usage

LOGIN/REGISTER

Guest Login (FOR LIVE SITE):

• Username: user
• Password: password

Login/password for project running locally will be different

VIEW RECORDS

1. Select material type to view available data tables
2. Data is organized by company, so under each material there is a list of buttons with the company names on them. Click one to view available materials from that company.

CREATE/UPDATE/DELETE RECORDS

BOTH OF THESE METHODS ARE ONLY AVAILABLE WHILE LOGGED IN

There are two ways to update records. The first is the record builder.

1. In order to build a record, you need the company name, color code, material type and quantity.
2. Click record builder, dill out appropriate fields with prepared data.
3. Submit.

The second is the inline update function in the table.

1. Each row of the table has three buttons attached to the end. If you don't need to create a new record, this is the preferred method of input for daily updates.
2. Click the button corresponding to the action you need to perform. For this, you only need the total weight change for the day, the company code and color code are handled.

VIEW REPORTS

Only one report is available for now, which is all materials updated in the previous rolling month period MORE COMING SOON

License

• Licensed under the Unlicense, meaning you can use this project or its code in any way you desire. Have at it!! See LICENSE.md for more info.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request