- 🚀 Introduction
- 🎨 Frontend Overview
- 🛠️ Technologies Used
- ⚡ Features
- 🔧 Configuration
- 🚀 Deployment
- 🤝 Contributing
- 📝 License
Welcome to the frontend section of the Automated Order Fulfillment System. This part encompasses the user-facing interface allowing users to place orders and manage the order pickup process.
The frontend is a web-based interface developed using modern web technologies. It facilitates user interaction by allowing users to place orders, associate items with RFID codes, and receive pickup confirmations.
The frontend utilizes the following technologies:
- React: JavaScript library for building user interfaces.
- Next.js: React framework for server-rendered applications.
- HTML/CSS/JavaScript: Core web technologies for structure, styling, and interactivity.
- Vercel: Deployment platform for hosting the frontend application.
- Prisma DB: ORM for TypeScript and JavaScript, enabling type-safe database access.
- PlanetScale: Scalable relational database system built on MySQL.
The frontend provides the following key features:
- Order Placement: Allows users to place orders through a user-friendly interface.
- RFID Association: Associates each item within an order with a unique RFID code.
- Order Pickup Confirmation: Provides confirmation and pickup details for users after order completion.
To configure the frontend:
- Install Prisma CLI: Run
npm install prisma -g
to install the Prisma CLI globally. - Setup Prisma Configuration: Create a
prisma/schema.prisma
file and define your data model for PlanetScale. - Database Connection: Define the connection to your PlanetScale database in
prisma/schema.prisma
. - Generate Prisma Client: Run
npx prisma generate
to generate the Prisma Client. - Environment Variables: Define environment variables for the frontend to connect with Prisma and PlanetScale.
For deployment:
-
Deployment Setup on Vercel:
- Create an account on Vercel.
- Connect your GitHub repository to Vercel.
- Define environment variables related to Prisma and PlanetScale in Vercel's settings.
-
Deploy Frontend Application:
- Trigger a deployment in Vercel after setting up configurations.
Contributions to improve UI/UX or add new frontend features are welcome! To contribute:
- Fork the repository.
- Create a new branch:
git checkout -b feature/your-feature
- Make changes and commit:
git commit -m 'Add your feature'
- Push to the branch:
git push origin feature/your-feature
- Submit a pull request.
This project is licensed under the GNU GPLv3 License.