Skip to content

SittingSeat/SittingSeat-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project Name: SittingSeat (Backend)

GitHub Java Spring Spring Boot JPA MySQL AWS Swagger

Brief Project Introduction

SittingSeat is a reservation platform designed to cater to both regular customers and restaurant owners. For regular customers, the platform allows them to search for restaurants, make reservations, and check their reservation history. For restaurant owners, they can register their restaurants on the platform, manage reservations, and view their restaurant's performance.

Tech Stack

  • Java 8
  • Spring Framework
  • Spring Boot 2.x
  • JPA 2.0
  • MySQL Database 8
  • AWS (Amazon Web Services)
  • Swagger for API Documentation

Members

  • 이동현 (Backend)
  • 조대영 (Frontend)
  • 박윤서 (Frontend)

Functionality

The SittingSeat Backend provides the following main functionalities:

  1. Restaurant Search: Regular customers can search for restaurants based on various criteria, such as restaurant name and cuisine.

  2. Reservation: Regular customers can make reservations for a specific date and time at their preferred restaurant.

  3. Reservation Management: Restaurant owners can manage the reservations received for their restaurant.

  4. Restaurant Registration: Restaurant owners can register their restaurants on the platform, providing essential details like location, cuisine type, contact information, etc.

  5. Reservation History: Regular customers can view their reservation history and check the status of their past and upcoming reservations.

How to Use

Follow these instructions to set up and run the SittingSeat Backend application:

  1. Prerequisites:

    • Java Development Kit (JDK) 1.8.0 or higher installed on your system.
    • IDE (Integrated Development Environment) - We recommend using STS or IntelliJ IDEA.
    • MySQL Database installed and running.
    • AWS account (if applicable) to deploy the application on the cloud.
  2. Clone the Repository:

  3. Database Configuration:

  • Create a MySQL database and update the database configuration in the application.properties file.
  1. Build and Run:
  • Open the project in your IDE and build it using Maven or Gradle.
  • Run the main application class to start the backend server.
  1. API Documentation:
  • Once the application is running, you can access the Swagger API documentation at http://localhost:{port}/swagger-ui.html.
  • Swagger provides a user-friendly interface to explore and test the available APIs.

Contribution

We welcome contributions to enhance the SittingSeat Backend application. If you encounter any issues or have ideas for improvements, please create a pull request or open an issue in the GitHub repository.


Feel free to fork the project and adapt it to your needs! If you have any questions or need assistance, please don't hesitate to contact us or open an issue on the GitHub repository.

Check out the GitHub repository for more information and updates on the project. Happy coding!
Made by AutoReadme Project (https://github.com/dongsuu/auto-generate-readme)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published