Skip to content

nicholas1022/hackathon-demo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

59 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Inventory and Order Management System

This Inventory and Order Management System is designed to solve the operational problems from Winful Seafood International Ltd, aimed at enhancing order accuracy, improving inventory management operations, and preventing over-selling.

We built an end-to-end solution with tech stacks that we are good at:

Frontend:

Next JS

TypeScript

MUI

TailwindCSS

Yarn

Backend:

Spring Boot

Java

Apache Maven

Postgres

Swagger

Firebase

Integration: REST API

Version Control:

Git

Motivation

We are a group of IT professionals from Hong Kong.

In early 2024, we participated in the first HK-CAN Hackathon in Toronto. At the event, we were presented with a real-world business challenge and seized the opportunity to apply our technological expertise to craft a tailored solution for our client, Winful Seafood International Ltd in 3 weeks.

Features

Inventory Management

  1. Create item to the inventory
  2. Update information of the items (e.g. name, quantity, price etc.)

Order Management

  1. Add, update, and delete desired items to the shopping cart
  2. Place a new order along with customer information
  3. Generate packing list for the inventory to pack the order
  4. Confirm order delivery after packing the order

How to run this project

This project combines a frontend built with Yarn and a backend powered by Spring Boot, managed with Maven. To get started, follow these steps:

Prerequisites:

  • Make sure you have Node.js and Yarn installed for managing the frontend dependencies.
  • Ensure you have Java and Maven installed for managing the backend dependencies.

Getting Started:

  1. Clone the Repository:

    git clone https://github.com/nicholas1022/hackathon-demo.git
    cd hackathon-demo
    
  2. Install Frontend Dependencies:

    cd hack-winful-web
    yarn install
    
  3. Run the Frontend:

    yarn dev
    
  4. Run the Backend:

    cd ..
    cd ord-sys-bn
    mvn spring-boot:run
    
  5. Access the Application: Once both the frontend and backend servers are running, you can access the application at http://localhost:3000 for the frontend and http://localhost:8080 for the backend.

Credits

Frontend: Iden Tang

Backend: Nicholas Lee (Backend Service), Ray Chen (Database)

API Integration: Iden Tang, Nicholas Lee, Jessica Chan

Documentation: Crafted by Iden Tang with ❤️, not ChatGPT

Special thanks to Winful Seafood International Ltd for providing real life business problem for case study.

Contact

Iden Tang: Linkedin

Nicholas Lee: Linkedin

Ray Chen: Linkedin

Jessica Chan: Linkedin

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages