Wild Eats - Restaurant Finder Project

Welcome to the Wild Eats project! This is our first project, and its primary objective is to create a web-based application that allows users to easily discover and filter restaurants located around our school. We'll be using HTML, CSS, and vanilla JavaScript to build this application.

Table of Contents

• Project Overview
• Features
• Getting Started
• Usage
• Contributing
• License

Project Overview

Wild Eats is a web-based restaurant finder that helps users find the perfect dining spot around our school. The project's main components include:

• A list of restaurants with key information (name, type of food, price range, etc.).
• A filtering mechanism that allows users to refine their restaurant search based on various criteria.
• A user-friendly interface with smooth navigation and responsive design.

Features

Here are the key features of the Wild Eats project:

• Restaurant List: Display a list of restaurants around our school, including details such as name, type of food, price range, and location.

• Filtering Options: Implement filters to allow users to narrow down their restaurant choices based on criteria such as food type, price, location, etc.

• Responsive Design: Ensure that the application is accessible and functional on various devices, including desktops, tablets, and mobile phones.

Getting Started

To get started with the project, follow these steps:

1. Clone the Repository: Begin by cloning this repository to your local machine using the following command:

   git clone <repository-url>

2. Open the Project: Navigate to the project directory and open it in your preferred code editor.

3. Explore the Code: Familiarize yourself with the project's file structure and the HTML, CSS, and JavaScript files.

Usage

To run the Wild Eats application locally, follow these instructions:

1. Open the project directory in your code editor.

2. Open the index.html file in your web browser.

3. Use the filters and search functionality to discover restaurants around our school.

4. Explore the features and functionality of the application.

Contributing

We welcome contributions from the community to improve the Wild Eats project. If you'd like to contribute, please follow these guidelines:

1. Fork the repository.

2. Create a new branch for your feature or bug fix: git checkout -b feature-name

3. Make your changes and commit them with clear and concise commit messages.

4. Push your changes to your forked repository.

5. Create a pull request with a detailed description of your changes.

License

This project is licensed under the MIT License, which means you are free to use, modify, and distribute the code as long as you provide appropriate attribution and include the same license in your derivative work.

Feel free to customize this README file to provide more specific details about your project, such as technical implementation details, project structure, and future development plans. Providing clear and comprehensive documentation will make it easier for others to understand and contribute to your project.

Contributors

Benoit Hayet

Cassiopée Laurie

Nassime Harmach

Aurore Valleix

Anaëlle Cauvin