Takeaway Website

This repository contains a takeaway website built using TypeScript, Next.js, Sequelize, MySQL, Tailwind CSS. This web application is designed to provide users with a simple way to place orders from a restuant.

There is current no live build of this project

Features

• Ordering System: Easily place and customize orders. Select items, specify preferences, and add them to your cart.

• Shopping Cart: A dynamic shopping cart that allows users to save, review and modify their orders before proceeding to checkout.

• Secure Payment Processing: Stripe, a trusted and industry-leading payment processing platform, is utilized to ensure the utmost security and reliability when handling payments.

• Real-time Order Tracking: Keep track of your order's status in real-time, from preparation to delivery.

• Order Management for Admins: Admins have the ability to efficiently manage and oversee orders. With an intuitive dashboard, they can track orders in real-time, update order statuses, and ensure a seamless ordering process for customers..

Technologies Used

• TypeScript: The entire project is written in TypeScript, ensuring type safety and better code quality.

• Next.js: I've used Next.js for server-side rendering and a faster page load experience. It also provides routing and API handling.

• Tailwind CSS: The user interface is styled using Tailwind CSS, allowing for quick and responsive design adjustments.

• Git: Git is the version control system of choice for managing and tracking changes to the project's source code.

• MySQL: Currently using MySQL as the database management system to store and retrieve data efficiently.

• Sequelize: To query the MySQL database efficiently and to prevent sequrity risks.

Knowen Bugs/Upcomming Changes

I am committed to continuously improving this project. Here are some bug fixes and changes I plan to implement in the future:

• Cart Storage: Change how the cart is stored to be linked to user accounts and to store multiple items using a quantity property. This will fix an issue when deleting items from your cart.

• Delete Account: Update the delete account backend to delete the users other table data. Currently if the user has any other data in these tables then it will throw an error.

• Products Storage: Store the products in the database and be able to update them to be inactive in the admin UI.

• Stripe Payment Elements: Migrate from using stripe payment elements to creating site UI to improve site consistancy.

Installation

1. Clone this repository to your local machine.

git clone https://github.com/TomPadmanathan/takeaway-website.git

2. Navigate to the project directory.

cd takeaway-website

3. Install the project dependencies.

npm i

4. Set environment variables.

cp .env.example .env

Then enter your environment variables.

5. Create a build.

npm run build

6. Start the server.

npm start

7. Open your browser and access the website at localhost:3000

Contribution Guidelines

Contributions from the community to help improve this project are more than welcome. If you'd like to contribute, please follow these guidelines:

• Fork the repository.
• Create a new branch for your feature or bug fix.
• Make your changes and ensure they are well-tested.
• Submit a pull request with a clear description of your changes.

Issues and Feedback

If you encounter any issues, have feedback, or want to suggest new features, please open an issue on this repository. I appreciate your input and contributions to make this project better.