Skip to content

nadinestrella/GiftList

Repository files navigation

The Gift List 😀👧👶🎁

Welcome to The Gift List, an interactive web application designed to make gift-giving occasions a breeze for parents and a world of fun for kids. With "The Gift List", children have the delightful opportunity to explore various toy categories and select their top three favorites, making sure their wishes are communicated directly and efficiently to their parents.

Features 🤳

  • Toy Categories: Kids can browse through a selection of toy categories to find exactly what they're interested in.
  • Curated Selection: Each category showcases 6 carefully selected toys to ensure a variety of options without overwhelming choice.
  • Child-Friendly Interface: Designed with young users in mind, our interface is simple, intuitive, and safe for kids to navigate.
  • Parental Notification: (work in progress) Once a selection is made, parents receive a neatly compiled list of the 3 chosen toys, making it easy to keep track of their child's current favorites.

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites 💻🖥️⌨️

Before you begin, ensure you have the latest version of Node.js installed on your computer to run the project without any hitches.

The GiftList API is on this repo, make sure you have followed the steps to set it up locally.

Installation 💻🖥️⌨️

  1. Clone the repo

    git clone https://github.com/nadinestrella/GiftList.git
    
  2. Install NPM packages

     npm install
    
  3. Run the application locally (frontend)

    npm run dev
    
  4. This command will start the app and open it in your default web browser. If it doesn't open automatically, you can visit http://localhost:5173/#/ manually.

Contributing 📩

We welcome contributions from the community! If you would like to contribute to "The Gift List", please follow these steps:

  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. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Contact 📬

Project Link: https://github.com/nadinestrella/GiftList