Inventory-tracker

401 group project

Caleb, Evan, Hawa, and Steven

Overview

• Full CRUD RESTful API, built with Express, MongoDB.

• Authorization and Authentication with Bcrypt and Crypto

• One system designed to handle all of a business' logistical needs.

• Handles your employee info.

• Handles customer info.

• Keeps your information up-to-date, so you can trust what the program tells you.

About

The why

Many businesses today are using a plethora of different programs to keep track of their shipping, receiving, and inventory. For the most part, these systems manage to get the job done, with no major problems. Some companies however, have daily issues that really should've never been issues in the first place. This API is meant to alleviate, if not solve many of the issues that businesses encounter when dealing with inventory quantities on a daily basis. This API will keep track of what a businesses has to sell, is selling, and what it has on order, all in real time. In addition to product information, the API will also keep track of all employee and customer information. This is a one stop shop to handle all of a business' needs.

The how

This is a full CRUD RESTful API, built with Express and MongoDB. Authorization and Authentication is accomplished with Bcrypt and the native node module, Crypto.

How can this API help you or your business?

• All needs are handled within one system.
• No miscommunication between one program to another.
• Up-to-date info, all the time.
• Operations are employee/privilege specific.
• You'll never sell product you don't have.
• Your life and logistical needs will be simplified.

Here is a visual to help you understand how the data is organized


Information will be stored and organized with the following models/mongoose schemas.

Store model:

• The store model is the epicenter of the API. Everything else connects to the store. Without a store, you have nothing.

  const storeSchema = Schema({
    name: {type: String, required: true},
    storeNumber: {type: String, required: true, unique: true},
    address: {type: String, required: true},
    timestamp: {type: Date, default: Date.now()},
    employees: [{type: Schema.Types.ObjectId, ref: 'employee'}],
    incoming: [{type: Schema.Types.ObjectId, ref:'inventoryOrder'}],
    outgoing: [{type: Schema.Types.ObjectId, ref: 'cartOrder'}],
    current: [{type: Schema.Types.ObjectId, ref: 'inventory'}]
  });

Employee:

• For employee accounts, containing employee info, including privileges for actions through the system. Certain employees can have certain abilities within the system. An admin employee has the ability to set this up.

  const employeeSchema = Schema({
    name: { type: String, required: true },
    username: { type: String, unique: true },
    email: { type: String, required: true },
    password: { type: String, required: true },
    storeID: {type: Schema.Types.ObjectId, required: true},
    admin: { type: Boolean, required: true },
    shipping: { type: Boolean, default: false },
    receiving: { type: Boolean, default: false }
  });

Inventory product:

• For holding current inventory. References the product and the quantity of the individual product.

  const inventoryProductSchema = Schema({
    name: { type: String, required: true },
    desc: { type: String, required:  true },
    quantity: { type: Number, required: true },
    inventoryOrderID: { type: Schema.Types.ObjectId },
    storeID: { type: Schema.Types.ObjectId, ref: 'store' }
  });

Inventory Order:

• For incoming orders(Orders that will replenish a depleted inventory). Inventory orders, once received will be dumped into the store's current inventory.

  const inventoryOrderSchema = Schema({
    inventories: [{type: Schema.Types.ObjectId, ref: 'inventoryProduct'}],
    storeID: {type: Schema.Types.ObjectId, required: true},
    test: {type: String }
  });

Customer:

• The customer model contains all the information about the individual customer. This information is kept private.

  const customerSchema = Schema({
    name: {type: String, required: true},
    username: {type: String, unique: true},
    email: {type: String, required: true, unique: true},
    password: {type: String, required: true},
    address: {type: String, required: true},
    currentOrders: [{type: Schema.Types.ObjectId, ref: 'cartOrder'}],
    pastOrders: [{type: String}]
  });

Cart Order:

• For individual orders, that will need to be shipped to customers. This will contain all the Information necessary for a shipping team to get their orders out on time.

  const cartOrderSchema = Schema({
    shippingAddress: {type: String, required: true},
    shippingName: {type: String, required: true},
    customerID: {type: Schema.Types.ObjectId, required: true},
    storeID: {type: Schema.Types.ObjectId, required: true},
    products: [{type: Schema.Types.ObjectId, ref: 'cartProduct'}]
  });

Cart Product:

• For holding the product and the quantity of the product in a specific cart.

  const cartProductSchema = Schema({
    name: {type: String, required: true},
    desc: {type: String, required: true},
    quantity: {type: Number, required: true},
    cartOrderID: {type: Schema.Types.ObjectId, required: true}
  });

Getting started

Start by cloning this repository: git clone <this repo>

Install the dependencies: npm i

Examples for reference

Base URL to the live version Inventory-tracker

Command Line Interface Instructions

This API is configured for use in the command line. It is set up to run on your computer's local IP (this IP can be accessed with the identifier localhost).

Before you can run this app locally, you need to set up your own environment variables locally. After you clone the app, in the command line, navigate into the root directory of the app and type touch .env Paste the following information:

PORT='8000' MONGODB_URI='mongodb://localhost/inventory-tracker' APP_SECRET='secret'

The port does not have to be 8000. Common port numbers for local development environments are 8000, 8080 and 3000. The app secret can be anything you want. Protect your app secret and never share your .env file.

You will need MongoDB installed locally. You will also need a command line http tool installed. I recommend httpie, and I assume you have it installed for this example. Instructions assume you are using port 8000.

POST

• In the command line, making sure you're in the root directory of your local version of the API, install the necessary dependencies for running the app by typing npm i

• In a separate window or pane of your command line interface, start MongoDB by typing mongod

• Then, start the node server by typing npm run start

• Let's set up a store. In a separate window or pane of your command line interface (the first two are running the node server and MongoDB in the background), type http POST localhost:8000/api/store name="Store Name" storeNumber="207" address="123 Any St, Seattle, WA"

• After you make this POST, you should get a response back that gives you the information about the store you just added and some information that Mongo adds for you. One of those properties will be an ID that you will use in your GET request. Don't clear your terminal. Trust us, you can't remember the ID!

Your response should look something like this

    HTTP/1.1 200 OK
    Access-Control-Allow-Origin: *
    Connection: keep-alive
    Content-Length: 213
    Content-Type: application/json; charset=utf-8
    Date: Fri, 13 Jan 2017 04:44:10 GMT
    ETag: W/"d5-YMji2yYf9nSVLCmA/XkzIQ"
    X-Powered-By: Express

    {
        "__v": 0,
        "_id": "58785b1a3b9d1ccef2798536",
        "address": "123 Any St, Seattle, WA",
        "current": [],
        "employees": [],
        "incoming": [],
        "name": "Store Name",
        "outgoing": [],
        "storeNumber": "207",
        "timestamp": "2017-01-13T04:44:10.715Z"
    }

GET

• To make a GET request.

Type http localhost:8000/api/store/<the id from your post response>

At this point, you should get a response back that looks the same as your POST response.

PUT

• Say you didn't enter that store number in right, you'll need to change it right?

Type http PUT localhost:8000/api/store/<the id to your store>? storeNumber='307'

Your response should look something like this

  HTTP/1.1 200 OK
  Access-Control-Allow-Origin: *
  Connection: keep-alive
  Content-Length: 213
  Content-Type: application/json; charset=utf-8
  Date: Fri, 13 Jan 2017 05:02:26 GMT
  ETag: W/"d5-VSi9KcGFhtlmpMFJDYStwQ"
  X-Powered-By: Express

  {
      "__v": 0,
      "_id": "58785b1a3b9d1ccef2798536",
      "address": "123 Any St, Seattle, WA",
      "current": [],
      "employees": [],
      "incoming": [],
      "name": "Store Name",
      "outgoing": [],
      "storeNumber": "307",
      "timestamp": "2017-01-13T04:44:10.715Z"
  }

DELETE

• What if you close your doors forever? It could happen.

Type http DELETE localhost:8000/api/store/<the id to your store>

Your response should look like this

  HTTP/1.1 204 No Content
  Access-Control-Allow-Origin: *
  Connection: keep-alive
  Date: Fri, 13 Jan 2017 05:08:59 GMT
  X-Powered-By: Express