Skip to content

BiteScout/BiteScout-Backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

bitescout-logo1-1

BiteScout is a comprehensive web application designed to streamline restaurant reservations, reviews, and management. It connects customers, restaurant owners, and admins, fostering a dynamic and interactive environment for dining enthusiasts and business owners alike.


Table of Contents


Overview

BiteScout aims to enhance the restaurant experience for both customers and restaurant owners. Customers can search for restaurants, make reservations, and leave reviews, while owners can manage bookings, menus, and special offers. Admins oversee the platform to ensure seamless operation and moderation.


Features

Customers

  • 🛡️ Register and log in using secure authentication.
  • 🔍 Search restaurants by name, cuisine, location, or ranking.
  • 🗓️ Make and manage reservations.
  • 💬 Write and interact with reviews (like, dislike, or reply).
  • View and favorite restaurants.
  • 🔔 Get notifications about reservations and offers.

Restaurant Owners

  • 🏢 Create and manage restaurant profiles.
  • 📋 Manage reservations, including approvals and cancellations.
  • 🎉 Create, edit, or delete special offers.
  • 🔔 Get notifications for bookings and reviews.

Admins

  • 🛠️ Moderate reviews and user activities.
  • 📊 Manage user and restaurant data.
  • 📈 Analyze user trends for system improvements.

Technologies Used

Frontend

  • 🌐 HTML
  • 🎨 CSS
  • 💻 TypeScript
  • ⚛️ React

Backend

  • ☕ Java
  • 🌱 Spring Boot
  • ⚙️ Kafka

Database

  • 🐘 PostgreSQL
  • 🍃 MongoDB

API

  • 🔗 RESTful API with JSON communication

Authentication

  • 🔑 JWT

Messaging

  • ✉️ Kafka for notifications

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.


Running the Application

  1. Clone the repository:

    git clone [https://github.com/yourusername/ReactApp.git](https://github.com/BiteScout/BiteScout-Backend)
    cd BiteScout-Backend
    cd BiteScout-Microservices
  2. Start Script:

    ./start-all.sh

    Contributing

We welcome contributions to BiteScout! To contribute:

  1. 🪝 Fork the repository.
  2. 🌿 Create a feature branch.
    git checkout -b feature-name
  3. 💾 Commit your changes.
    git commit -m "Description of your changes"
  4. 🚀 Push to your branch.
    git push origin feature-name
  5. 🔄 Create a Pull Request.

For major changes, please open an issue first to discuss what you would like to change.


We hope BiteScout enhances your dining and restaurant management experience!

About

The back-end implementation of BiteScout web application.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 6