guipmdev / sundaes-on-demand

Web app for ordering custom sundaes, with a focus on testing

sundaes-on-demand

Go to the web application ↗

📒 Table of Contents

• 📍 Overview
  • ⚠️ Disclaimer
• ✨ Features
• 🤖 Demo
• 🛠 Technologies
  • Website
  • Server
  • Utils
• 🚀 Getting Started
  • ✔️ Prerequisites
  • 📦 Installation
  • ⚙️ Usage
  • 🧪 Running tests
• 📄 License
• 👏 Acknowledgments

📍 Overview

The sundaes-on-demand project is a web application developed in React for ordering custom sundaes, allowing you to choose from different flavors and toppings. The application calculates the total price based on the selections and provides a user-friendly interface for sending the orders.

This project targets the dessert store segment, simplifying the online ordering process and providing an interactive and personalized experience for customers.

⚠️ Disclaimer

The back-end of this application is built with Node.js and does not have a deployment, as the focus is primarily on the tests. To fully test the application, you'll need to clone the repository, run the start script, and then open the website.

✨ Features

🍨 Make sundaes choosing from a variety of flavors and toppings

🛵 Confirm your order and wait for it to arrive (only symbolic)

🧪 Project focused on Jest and Testing Library tests

🤖 Demo

sundaes-on-demand.mp4

🛠 Technologies

The following tools were used to build the project:

Website

* See the package.json file

Server

Utils

🚀 Getting Started

✔️ Prerequisites

Before you begin, ensure that you have the following tools installed on your machine: Git, Node.js. It's also good to have an editor to work with the code, such as VSCode.

📦 Installation

1. Clone the backend repository:

git clone https://github.com/guipmdev/sundae-server/

2. Change to the backend directory:

cd sundae-server

3. Install the dependencies:

npm install

4. Go back and clone the project repository:

cd ..

git clone https://github.com/guipmdev/sundaes-on-demand/

5. Change to the project directory:

cd sundaes-on-demand

6. Install the dependencies:

npm install

⚙️ Usage

1. Enter the backend directory:

cd sundae-server

2. Start the server:

npm run start

3. Change to the project directory:

cd ../sundaes-on-demand

4. Start the web application:

npm run dev

5. Access https://localhost:3000/ (or https://guipmdev-sundaes-on-demand.vercel.app/) to view the application

🧪 Running tests

npm run test

📄 License

This project is licensed under the terms of the MIT license. See the LICENSE file for additional info.

👏 Acknowledgments

• Many thanks to Bonnie Schulkin for the layout and tips when putting this project together

---

Made with 💙 by @guipm.dev - Feel free to contact me!

↑   Return to the top   ↑