Code Monkey home page Code Monkey logo

qr-code-inventory-management-system's Introduction

QR Code Inventory Management System

Track inventory using QR codes for rapid scanning and management.

📔 Table of Contents

🌟 About the Project

Revolutionize your inventory management with our QR Code Inventory Management System. Easily track and manage your inventory by scanning QR codes. Streamline your operations, minimize errors, and increase efficiency.

🔑 Environment Variables

Client (client/)

The following environment variable is required in the client folder:

  • VITE_API_BASE_URL: This variable should be set to the base URL of the API endpoint. It's used by the client to communicate with the server.

To set up this variable, create a .env file in the client/ directory and add the following line: VITE_API_BASE_URL=https://your-api-base-url.com/api

Make sure to replace https://your-api-base-url.com/api with the actual base URL of your API.

Server (server/)

The following environment variables are required in the server folder:

  • MONGO_URI: This variable should be set to the connection URI for your MongoDB database.

  • JWT_SECRET: This variable should be set to the secret key used for signing JSON Web Tokens (JWTs) for authentication.

To set up these variables, create a .env file in the server/ directory and add the following lines: MONGO_URI=your-mongo-db-uri JWT_SECRET=your-jwt-secret

Replace your-mongo-db-uri with the actual connection URI for your MongoDB database, and your-jwt-secret with the secret key you want to use for JWT signing.

Note: An example .env file is provided as .env.example in both the client/ and server/ directories. Make sure not to commit your .env files with sensitive information to your version control system.

🧾 Schema Diagram

Schema Diagram

🧰 Getting Started

⚙️ Installation

This project uses Yarn as package manager

npm install --global yarn

Install dependencies

yarn install

🏃 Run Locally

Clone the project

git clone https://github.com/MobinurRahaman/qr-code-inventory-management-system
cd qr-code-inventory-management-system

Install dependencies

yarn install
yarn add -D concurrently -W

Add .env files in both client/ and server/ directories as described in the Environment Variables section

Start the server

yarn run start:dev

🚩 Deployment

To deploy this project run

yarn deploy

qr-code-inventory-management-system's People

Contributors

mobinurrahaman avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.