Skip to content

Latest commit

 

History

History
206 lines (86 loc) · 4.45 KB

README.md

File metadata and controls

206 lines (86 loc) · 4.45 KB

Inventory Management App

A Store System built with Electron, Tailwind, React, Syncfusion, Zustand, MongoDB and Vite.

Some Screens

Login

Add-User

Cashier-Closed

Cashier

Alerts

Products

Sale

Sale

Sale

Discount

Payment

Backup

About this Project

This project is a production ready inventroy management App, so, I'll be happy if you could provide me any feedback about the project, code, structure or anything that you can report that could make me a better developer!

The language is French but i will provide an English version very soon

Email-me: tokochi@hotmail.fr

Connect with me at LinkedIn

Also, you can use this Project as you wish, be for study, be for make improvements or earn money with it!

It's free!

Installers

If you just want to see the App running or want to use this project in production, you can just download the installer of the app in the OS version desired.

Linux .AppImage installer

MacOS .dmg installer

Windows .exe installer

Make sure to install the mongoDb driver : mongoDB-Driver!

Some technical information

The structure of the project was based on this amazing plugin electron-vite , that helped me with the initial structure of the project, and a faster Electron Dev environement.

With some changes, was possible to make the Project more clear, separating the modules of front-end from the back-end, what also made the process of perform the build process more easier.

Functionalities

This Project supports the following operations:

  • Login/Logout

  • Backup

  • Activities

  • Invoices

  • Reports

  • Print inventory

  • Alerts, Notifications about: Customers in debit, Budgets out of date and Products with low stock.

Management of :

  • Cashier

  • Sales

  • Products

  • Stock

  • Budgets

  • Customers

  • Providers

  • Users

Getting Started

Prerequisites

To run this project, be either in development or production, you'll only need to have the npm installed and, to run the Database, you'll need the MongoDB installed.

Installing

Cloning the Repository

$ git clone https://github.com/tokochi/inventory-app

$ cd inventory-app

In all the followings instructions, I'll be using the yarn, but you can also use npm.

Installing dependencies

$ yarn

Running in Development

$ yarn dev

Build

$ yarn build

Built With

Contributing

You can send how many PR's do you want, I'll be glad to analyse and accept them! And if you have any question about the project...

Email-me: tokochi@hotmail.fr

Connect with me at LinkedIn

Thank you!

License

This project is licensed under the MIT License