InventoryPilot
InventoryPilot is a tailored solution for Concept Store Fixtures (CSF) International, the leading manufacturer of aftermarket parts and accessories in North America. InventoryPilot automates task allocation, tracks live inventory, and provides a real-time management dashboard, enhancing efficiency and ensuring production goals are met efficiently.
Install / Use
/learn @Irisvella/InventoryPilotREADME
InventoryPilot - https://inventory-pilot.vercel.app/
Release Demo
Release 3: https://drive.google.com/file/d/1A0P-mhyDx5q1hXIzOz_FQGD1S1wqSAA2/view?usp=sharing <br/> Release 2: https://drive.google.com/file/d/1UAyWNS10-HoNQkFiJOYEpXlHf-HG4FO0/view?usp=sharing
Top 5 most important files
| File path with clickable GitHub link | Purpose | |--------------------------------------|----------| | orders.views.py | Core feature logic of generating inventory pick list and manufacturing list | | inventory.views.py | Core feature logic of assigning an order picklist to a staff member | | oa_input.views.py | Core logic to input orders to our system | | inventory-stock/App.tsx | Displays the warehouse inventory stock | | InventoryPickListItem.jsx | Displays the main UI picker staffs will use |
Top 5 most important tests
| File path with clickable GitHub link | Purpose | |-|-| |orders.tests.py | Test for manufacturing list and inventory pick list generation backend logic | |inventory.tests.py | Test for inventory stock levels manipulation | |label_maker.tests.py | Test for generating labels | |log_actions.tests.py | Test for user picking logs | |UI testing | UI Testing for the frontend |
Description
InventoryPilot is a tailored solution for Concept Store Fixtures (CSF) International , the leading manufacturer of aftermarket parts and accessories in North America. Known for fast lead times and competitive pricing, CSF requires streamlined production and operations management. InventoryPilot automates task allocation, optimizes machine utilization, tracks live inventory, and provides a real-time management dashboard, enhancing efficiency and ensuring production goals are met effectively.
Team Members
| Name | ID | GitHub ID | Email | |--------------------------|------------|-----------------------|------------------------------| | Andy Sun | 40192040 | Irisvella | Andysunham@gmail.com | | Christa Abou-Arraje | 40226631 | christa-ux | christa.arraj@gmail.com | | Fatoumata Binta Barry | 40213443 | Fatoumatabintabarry | bintabarry2002@yahoo.ca | | Flora Avakian | 40158192 | flo351 | flora.avakian@yahoo.ca | | Inas Fawzi | 40208675 | inas-fawzi | inasfawzi24@gmail.com | | Megan Coscia | 40214186 | m-coscia | meg.coscia@gmail.com | | Nour Hadie Hassoun | 40233077 | iluvpesto | n_hassoun3@hotmail.com | | Sarah Abellard | 40184667 | sarahabellard | sarahzinea@gmail.com | | Suha Abubakr | 40120785 | suha-ab | abubakr.suha@gmail.com | | Yousef Enein | 40115494 | yousefenein | yousefenein@outlook.com | | James Bitharas | 26637175 | strikeyamato | jamesbitharas@gmail.com |
Developer getting started guide
Prerequisites
- Python 3.10 or later
- Node.js 16.x or later
clone the repository
git clone https://github.com/christa-ux/InventoryPilot.git
<ins>Note:</ins> To run the backend and frontend, you should run two shells simultaneously. The first shell is for the backend and runs python. The second shell is for the frontend and runs node.
To run the backend
cd WarehousePilot_app\backend
pip install -r requirements.txt
create the .env file and add the environment variables
python manage.py migrate
To run server:
python manage.py runserver
For frontend
cd WarehousePilot_app
cd frontend
To download front-end dependencies: nextUI, reactJS, TailwindCSS, chartJS, heroicon, vite)
npm install
add the .env.development file to connect to the backend
npm run dev
control click on the localhost to open the webpage
To run as a Docker container
Make sure to have Docker for desktop installed here.
Add the .env file in the root directory and build your images and container using
docker-compose build
You can run the command below and control-click on local host to open the webpage
docker-compose up
Wiki table of contents
- Collection of All Meeting Minutes
- Documentation of Stakeholder Meetings
- Risks
- Legal and Ethical Issues
- Economic Impact
- Personas
- Diversity statement
- Overall Architecture and Class Diagrams
- Infrastructure and tools
- Name Conventions
- Testing Plan and Continuous Integration
- Security
- Performance
- Deployment Plan and Infrastructure
- Next Iteration Plan and Rollout Strategy
