Mouzayan / red-squirrel

An inventory management web application built with the MERN stack.

Home Page:http://www.red-squirrel.surge.sh

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Alt Text

Red Squirrel

Overview

Red Squirrel is a visual inventory management and tracking software that allows the user to input items and their details as well as track changes to the quantities of the items. This app is designed to provide the user with a simple interface for taking the guesswork out of managing inventory.

Wireframes

Mobile Landing Page

Mobile Sign Up Page

Mobile Log In Page

Mobile Inventory Page

Mobile Create Item Page

Mobile Edit Item Page

Desktop Landing Page

Desktop Sign Up Page

Desktop Log In Page

Desktop Inventory Page

Desktop Create Item Page

Desktop Edit Item Page

MVP Goals

The homepage will have will have sign up and login prompts to allow users to create and secure personal accounts. Once signed in, the homepage will show a cumulative inventory panel of all the user's products. The item page will display a particular product that had been added to the master list as well as allow the user to update current stocked quantities or desired minimum inventory levels. The app will utilize React, JS, CSS, and mongoDB. React and JS will render data stored on our development api created with mongoDB. The site would be hosted on Surge.

Libraries

Library Description
axios To make get requests to API
body-parser Body parsing middleware
cors CORS enabling middleware
express Web framework for node
framer-motion Page transitions
jest JavaScript testing
mongoose MongoDB object modeling tool
morgan HTTP request logger middleware
nodemon Auto restart app on save
react-router-dom Link and Route components
supertest Component library

Component Hierarchy


root
|__ client/
      |__ public/
            |__ index.html
      |__ src/
      |__ components/
            |__ shared/
                  |__ Header.js
                  |__ Footer.js
                  |__ Layout.js
            |__ Home.js
            |__ ItemCreate.js
            |__ ItemDetail.js
            |__ ItemEdit.js
            |__ Inventory.js
            |__ SignIn.js
            |__ SignUp.js
            |__ services/
                  |__ apiConfig.js
                  |__ items.js
                  |__ app.js
                  |__ index.js
            |__ README.md
            |__ package-lock.json
            |__ package.json
|__ controllers/
      |__ index.js
|__ db/
      |__ index.js
|__ models/
      |__ user.js
      |__ item.js
|__ routes/
      |__ index.js
|__ seed/
      |__ usersItems.js
|__ tests/
      |__ base.test.js
      |__ routes.test.js
|__ .gitignore
|__ app.js
|__ info.yml
|__ package-lock.json
|__ package.json
|__ README.md
|__ server.js

Post-MVP

Red Squirrel allows the user to maintain a balance between too much and too little inventory. Color codes highlight levels of inventory that fall below the desired minimum inventory level.

Team Members

Created, designed and developed by Yolea Mayers, Michael Reidy, Mouzayan Delbourgo and Jose Ferreira (Git Czar) for the General Assembly Software Engineering Immersive (February '20 Cohort) Unit 3 Project.

About

An inventory management web application built with the MERN stack.

http://www.red-squirrel.surge.sh


Languages

Language:JavaScript 59.5%Language:CSS 34.9%Language:HTML 5.6%