InStock - Client

Welcome to the front-end repository of the InStock project. This repository contains the code for the React-based front-end of the Inventory Management System. This project was developed as part of a web development bootcamp, where collaboration and Agile development methodologies were emphasized.

See also server repo: https://github.com/mannyv123/instock-server

Table of Contents

1. Project Overview
2. Screenshots
3. Features
4. Tech Stack
5. Run Locally
6. Environment Variables

Project Overview

The InStock project was developed during a web development bootcamp as a collaborative group project. The goal was to deliver a modern and scalable Inventory Management System for a client. The project required working as an Agile team, following Scrum methodologies and using tools like JIRA, Figma, and Git/GitHub for efficient collaboration and project management.

Screenshots

Features

• Overview of warehouses and inventory levels per warehouses
• Overview of total inventory by inventory type
• Create / delete inventory or warehouses
• Edit inventory or warehouse details
• Search and filtering functionality to find specific warehouses or inventory
• Form validation when creating new or editing existing warehouses/inventory
• Responsive design so that the site responds to mobile, tablet, and desktop views

Tech Stack

Client: React, React Router, BEM/SASS, Figma (design)

Server: Node, Express, MySQL, Knex, Postman (for testing APIs)

Note that the project also involves using Agile development methodologies, including JIRA for project management and the Scrum methodology for collaborative workflow.

Run Locally

To set up the front-end locally, follow these steps:

Clone this repository to your local machine using the following command:

  git clone git@github.com:mannyv123/instock-client.git

Navigate to the project directory:

  cd instock-client

Install the required dependencies using npm:

  npm install

To start the development server and run the front-end locally, use the following command:

  npm run start

This will launch the application in your default browser and automatically reload it whenever you make code changes.

Make sure to also clone and run the back-end server as well: https://github.com/mannyv123/instock-server

Environment Variables

To run this project, you will need to add the following environment variable to your .env file (see also .env.sample file):

REACT_APP_API_URL