Skip to content

RaoSam-Code/nexstock

Repository files navigation

NexStock 📦✨

NexStock is a Premium Inventory Management System built with a state-of-the-art tech stack and designed around a highly immersive, physical user interface.

🚀 Live Site: nexstock-rust.vercel.app

Warning

Since we are utilizing the free tier of service on our hosting providers, the initial loading of the project might feel slow as the backend web service spins up. We appreciate your patience!


🏗️ Architecture & Deployment

NexStock features a decoupled, modern architecture designed for scale and developer speed:

  • Frontend: Built with Next.js 15 (App Router) and React 19, deployed on Vercel for high-performance edge rendering.
  • Backend: An asynchronous API powered by FastAPI (Python), hosted on Render.
  • Database: PostgreSQL (with SQLAlchemy ORM), hosted on Render.

🎨 Design System & Aesthetics (OP Premium)

NexStock stands out with an "OP Premium" design language, elevating standard administrative dashboards into an interactive, visual experience:

  • Claymorphic / Neomorphic UI: Uses custom soft dual drop-shadows with extreme spread and inner inset shadows (.shadow-clay, .shadow-clay-pressed) for a 3D extruded silicone feel.
  • Modern Typography: Uses the geometric Outfit Google Font globally.
  • Interactive Physics: Spring-based animations (Framer Motion and GSAP) with high stiffness and low damping to ensure that elements bounce and follow physical layouts.
  • Custom Cursor: Trailing physics-based ring and blending dot (mix-blend-difference) that expands when hovering over interactive elements.

🌟 Key Features

NexStock includes everything required to run complex warehousing and inventory operations:

  1. Analytical Dashboard:
    • Real-time metrics tracking Revenue, Cost, Profit, and Low-stock count.
    • Visual revenue vs. cost trends using Recharts area charts.
    • Rankings for top-selling and least-selling items.
    • Activity log showing recent order statuses.
  2. Product & Inventory Control:
    • Complete inventory list with fields for images, names, quantity, price, unit costs, and SKU.
    • Critical warning flags for items falling below custom low-stock thresholds.
    • Add/Edit/Delete products with an animated, neumorphic modal interface.
  3. Customer Directory:
    • Track customer accounts with email verification and order history logs.
  4. Supplier Network & Purchase Orders (Restocking):
    • Maintain supplier records and generate Purchase Orders.
    • Inventory is automatically incremented and unit cost updated when orders are received.
  5. Shipping & Outbound Logistics:
    • Manage customer orders and record shipments.
    • Inventory levels are validated upon shipment to prevent stock overselling, automatically subtracting items from stock.
  6. Robust Authentication:
    • Fast, secure JWT token authentication securing API routes on the FastAPI server.
  7. Containerization & CI/CD:
    • Fully dockerized development workflow with docker-compose.
    • GitHub Actions configured for automated linting, testing, and builds.

🛠️ Getting Started

To spin up NexStock in your local development environment:

Using Docker Compose (Recommended)

  1. Make sure Docker is running on your machine.
  2. Spin up all containers (Next.js, FastAPI, and PostgreSQL):
    docker-compose up --build
  3. Open http://localhost:3000 for the frontend and http://localhost:8000/docs for the interactive Swagger API documentation.

For manual local environment setup, please refer to the detailed guide in CONTRIBUTING.md.


🤝 Project Policies & Guidelines

We maintain high standards for community guidelines, security, and developer code standards. Please review the following documentation before making contributions:

  • 📜 Code of Conduct: Details our expectations for behavior and community standards.
  • 🛠️ Contributing Guidelines: Step-by-step setup guides, code styling (React/Python), and pull request instructions.
  • 🛡️ Security Policy: Rules for reporting vulnerabilities responsibly.
  • ⚖️ License: Licensed under the permissive open-source MIT License.

Issue & Pull Request Templates

We enforce structured formats for tracking issues and contributions:

About

NexStock is a **Inventory Management System** built with a state-of-the-art tech stack and designed around a highly immersive, physical user interface.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors