Tiffin Box

The project’s purpose is to provide a platform through which the food ordering and delivery process becomes easy for both the customers and food service providers. It also has an administrator role to manage the customers and food service providers of the application. Our goal is to enhance the overall food experience by providing a platform for effective order tracking and meal management. With features like tracking deliveries in real-time, earning reward points, and easy-to-use dashboards, we aim to make the experience smooth for everyone.

• Deployment URL: https://tiffinbox-csci5709.netlify.app/

Getting Started

Prerequisites

To have a local copy of this project up and running on your local machine, you will first need to install the following:

• NodeJS v20.x
• npm v10.x
• JDK Java 17
• Maven
• MongoDB

Installing

Clone the Repository

Clone with HTTPS

 git clone https://github.com/Keval-Gandevia/TiffinBox.git

OR

Clone with SSH

git clone [email protected]:Keval-Gandevia/TiffinBox.git

Local Setup - Frontend

cd tiffinbox/frontend
npm install
npm run dev

Frontend should be running on http://localhost:5173/

Local Setup - Backend

cd tiffinbox/backend/
mvn spring-boot:run

The backend should be running on http://localhost:8080/

Deployment

This app has been deployed on Netlify (Frontend) and Render (Backend).

• Frontend Deployed App URL: https://tiffinbox-csci5709.netlify.app/
• Backend Deployed App URL: https://tiffin-box.onrender.com

Deployment to Netlify

1. Login to Netlify: Sign up or log in at Netlify.

2. Create a New Site:

• Click "Add new site".
• Connect your GitHub account and select your repository.

3. Configure Settings:

• Base directory: frontend
• Build Command: npm run build
• Publish Directory: /frontend/dist
• Deploy: Click "Deploy site".

Built With

• React - The JavaScript library used for building the user interface.
• Vite - The build tool used for faster and leaner development.
• Tailwind CSS - Utility-first CSS framework for rapidly building modern websites.
• Daisy UI - Tailwind CSS component library.
• npm - Dependency Management.
• Spring Boot - The backend framework used
• Java - The programming language used
• Maven - Used as a build tool and for dependency management.
• Docker - Used for containerization.
• MongoDB - Database used.

Acknowledgments

• Spring Boot
• Render
• Docker
• ViteJS
• daisyUI
• Tailwind CSS
• MongoDB Atlas
• Netlify
• Cloudinary