SeatFrenzy

Restaurant Table Booking System

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Tech Stack
3. Getting Started
4. Contributing
5. License
6. Contact

About the Project

SeatFrenzy is a restaraunt booking system, allowing visitors to quickly check availability and easily book a table at their favourite restaurant. It also allows restaurant owners to promote their venues by listing them on the website, and to manage their bookings or information displayed on the website.

The goals is not only to make it a table booking system, but also a full restaurant management system, allowing restaurant owners to manage their bookings, menus, and other information displayed on the website.

Warning This project is still in active development.

It uses new technologies (server actions, serverless database connection, etc. ), which are subject to change and may break your application. It is not recommended to use this project in production yet.

(back to top)

Tech Stack

• Framework: Next.js 14
• Styling: Tailwind CSS
• UI Components: shadcn/ui
• Database: PlanetScale MySQL
• ORM: Drizzle ORM
• Authentication: Next-Auth
• File Upload: UploadThing
• Forms: React Hook Form
• Email: React Email
• Validation: Zod
• Hosting: Vercel
• Project Management: Jira

(back to top)

Getting Started

Prerequisites:

• Node.js (version 18 or higher)
  

Installation:

1. Clone the repo

   git clone

   
   

2. Install packages

    pnpm install

   
   

3. Rename a .env.example file in the project's root directory and fill in the required values. See below for details on obtaining the keys:
   

   • PlanetScale:
     
     

     • Create a new account with PlanetScale
     • ToDo: Complete the setup instructions
       
       

   • OAuth Credentials:
     
     

     • ToDo: Complete the setup instructions
       
       

   • NextAuth:
     
     

     • ToDo: Complete the setup instructions
       
       

   • Resend:
     
     

     • ToDo: Complete the setup instructions
       
       

   • UploadThing:
     
     

     • Create a new account with UploadThing
     • ToDo: Complete the setup instructions
       
       

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Run code formatting (pnpm format)
5. Run code linting (pnpm lint)
6. Push to the Branch (git push origin feature/AmazingFeature)
7. Open a Pull Request

(back to top)

License

Distributed under the MIT License.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

(back to top)

Contact

Piotr Borowiecki - @pjborowiecki - hello@pjborowiecki.com

(back to top)