My Inventory

v4.0

Summary

• What is it?
• Development Status
• Features
• Technologies Embed
• Tools Used
• How to Run
• Contact
• Licensing

What is it?

An app to handle and manage inventory and/or kitchens.

Development Status

Project currently under development;

Features

• Store and manage product data, such as quantities and expirations;

• Show what's expirating on;

• Expired products may no longer be visible for user(coming soon);

• Data storage with it's own api using NodeJS and PostgreSQL;

• PWA version coming soon, or not so soon rs.

Teconolgies embed

• Vite

• Tailwind CSS

• ReactJS

• Firebase

• ESLint

• Prettier

Tools used

• Figma

• NeoVim

• Termux

How to run

Warning: to run this project properly it's counterpart, the api, must be cloned, setup and running as well.

First, clone this repo:

• Via SSH:

$ git clone git@github.com:xSallus/my-inventory-front.git

• Via HTTPS:

$ git clone https://github.com/xSallus/my-inventory-front.git

Then, after enter in project folder via comand line, install all the dependencies, just run:

$ yarn

Then, for web version, run the development server:

yarn dev

Finally, open 'http://localhost:3000' with your browser to see the result.

And for mobile version, run the expo application and... [coming soon...]

Known bugs

• None right now :D

Contact the Dev

• Github  
• Linkedin  

Licensing

Licensed under MIT License,  see more;

2020 - 2022, xSallus©.