Skip to content

Latest commit

 

History

History
91 lines (69 loc) · 2.16 KB

README.md

File metadata and controls

91 lines (69 loc) · 2.16 KB
Raw

Inventory Management App

Inventory Management App an app which i am trying to make. It will be a full-fledged inventory management system. Making it for my path to learn go and next.js more!

TODO

  • Login/Register Email based Authentication
  • Dashboard Admin/Other staff
  • Implement RBAC
  • Add Database for Item/Inventory/Seller
  • Bar Code labeling system for products
  • Stock Management
  • Notifications & Alerts

Technologies Used

Frontend

  • Next.js: A JavaScript library for building user interfaces.

Backend

  • Fiber: A Golang package for server-side logic.
  • PGX: A PostgreSQL driver for Go.
  • Go-JWT: For authentication and authorization.
  • Go-Redis: For caching and verification management.

Other Stuff

  • Resend: For managing and sending mails
  • Docker: For containerization and deployment.
  • PostgreSQL: For the database.
  • Redis: For caching and verification management.

Installation

To set up this project locally, follow the steps below:

  1. Clone the Repository

    git clone https://github.com/AriaFantom/Inventory-Management.git
cd Inventory-Management

  2. For development the App

    • Backend (Golang 1.23):

      cd backend
      go install github.com/air-verse/air@latest
      go install github.com/pressly/goose/v3/cmd/goose@latest
      go mod tidy
      docker-compose up -d
      air

    • Frontend (Node.js 21.0.0):

      cd frontend
      npm install
      npm run dev

    The backend will run by default on http://localhost:8080 and the frontend on http://localhost:3000.

Contributing

We welcome contributions! Please follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch.
  3. Make your changes
  4. Open a pull request and explain what changes you’ve made.

License

This project is licensed under the MIT License. See the LICENSE file for more details.