Skip to content

Latest commit

 

History

History
76 lines (64 loc) · 2.78 KB

README.md

File metadata and controls

76 lines (64 loc) · 2.78 KB

SupplySync - An Inventory Management System

A full-stack web application that allows users to efficiently manage product inventories. This project includes features such as user authentication, stock management, and product tracking. Built as part of the Google Developer Student Club (GDSC) selection process at Jaypee Institute of Information Technology.

🔗Links

🛠 Features

  • User Authentication (Sign up, Login, Delete, Update Password, Reset Password)
  • Add, Edit, Delete, and View Products
  • Manage stock levels
  • Responsive design with Tailwind CSS
  • Secure and scalable with Firebase Authentication and Firestore Database

🔧 Tech Stack

  • Frontend:
    • Next.js (Server-side rendering, Routing)
    • Tailwind CSS
  • Backend:
    • Next.js (for creating custom backend APIs)
    • Firebase Authentication
    • Firestore (NoSQL Database)
  • State Management: React Hooks
  • Deployment: Vercel & Netlify

📦 Tools Used

  • Next.js: For server-side rendering and routing
  • Git & GitHub: For version control
  • Firebase: For authentication and database
  • Postman: API testing
  • Vercel & Netlify: For deployment

⚙️ Setup & Installation

  1. Clone the repository:
git clone https://github.com/VaibhavKatariya/SupplySync.git
  1. Install dependencies:
npm install
  1. Set up your Firebase project and add the .env.local file:
NEXT_PUBLIC_FIREBASE_API=your-api-key
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your-auth-domain
NEXT_PUBLIC_FIREBASE_PROJECT_ID=your-project-id
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your-storage-bucket
NEXT_PUBLIC_FIREBASE_MESSAGING_ID=your-messaging-sender-id
NEXT_PUBLIC_FIREBASE_APP_ID=your-app-id
FIREBASE_PROJECT_ID=your-project-id
FIREBASE_PRIVATE_KEY=your-base64-encoded-private-key
FIREBASE_CLIENT_EMAIL=your-client-email
  1. Run the development server:
npm run dev
  1. Open http://localhost:3000 to see the app in action.

📖 Usage

  • Authentication: Users can sign up or log in to access the inventory system.
  • Manage Products: Add, edit, or delete products and manage stock levels from the dashboard.
  • Responsive Design: The app is optimized for both mobile and desktop use.

👨‍💻 Contributors

Image of contributors

📜 License

  • This project is licensed under the MIT License. MIT License