Home

BiteBooker Wiki

Welcome to the BiteBooker Wiki! This page provides detailed documentation to help users, contributors, and developers understand and work with the BiteBooker project.

---

Table of Contents

1. Overview
2. Features
3. Getting Started
4. Project Structure
5. Technologies Used
6. How to Contribute
7. License

---

Overview

BiteBooker is a full-stack web application designed to make food booking and meal pre-booking easy and efficient. It consists of three main components: Admin, Backend, and Frontend. Each component serves a specific purpose, ensuring scalability and seamless functionality.

Key Highlights

• Built with modern web technologies.
• Includes an Admin Panel for managing users and bookings.
• Secure authentication with JWT and bcrypt encryption for passwords.

---

Features

• User-Friendly Interface: Intuitive design for both users and administrators.
• Authentication and Security: Secure user authentication using JSON Web Tokens (JWT).
• Notification System: Real-time alerts with React Toastify.
• Database Management: MongoDB Atlas for storing and managing data.
• Full Stack Architecture: Modular structure for better scalability and maintenance.

---

Getting Started

Prerequisites

• Install Node.js (v16 or higher) and npm or pnpm.
• Ensure you have a MongoDB Atlas account.

Setting Up the Project

1. Clone the repository:

   git clone https://github.com/rishibharadwajsai/BiteBooker.git
   cd BiteBooker

2. Set up the three components:

   • Admin: Navigate to the admin folder and run:

     pnpm install # or npm install
     pnpm run dev # or npm run dev

     Access at http://localhost:5173.

   • Backend: Navigate to the Backend folder and run:

     pnpm install # or npm install
     pnpm start   # or npm start

   • Frontend: Navigate to the Frontend folder and run:

     pnpm install # or npm install
     pnpm run dev # or npm run dev

     Access at http://localhost:5174.

3. Ensure all three servers are running simultaneously.

---

Project Structure

• admin: Admin interface built with React.js.
• Backend: API and business logic written in Node.js and Express.
• Frontend: User-facing interface built with React.js.

Directory Layout

BiteBooker/
│
├── admin/        # Admin panel code
├── Backend/      # Backend API and server logic
├── Frontend/     # User-facing frontend code
│
└── LICENSE       # Project license

---

Technologies Used

• Frontend: React.js, React Toastify
• Backend: Node.js, Express.js
• Database: MongoDB Atlas
• Authentication: JSON Web Tokens (JWT)
• Styling: CSS
• Additional Packages: bcrypt, cors, and more.

---

How to Contribute

Contributions are welcome! Follow the guidelines in the CONTRIBUTING.md file for more details on how to get started.

Reporting Issues

If you find any bugs or have feature requests, please open an issue in the Issues tab.

---

License

BiteBooker is licensed under the MIT License. For details, refer to the LICENSE file.

---

Feel free to explore the repository, contribute to the project, or reach out with any suggestions or improvements!