djmotor90 / project-REST-rant

Home Page:https://project-rest-rant-plum.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

REST-Rant ๐Ÿ”๐Ÿ•

Build Status License Version

REST-Rant is a community-driven app where foodies can review restaurants. Discover new places to eat, or contribute your own experiences to help others!

Table of Contents

Features ๐Ÿœ๐ŸŒฎ

  • Browse reviews of different restaurants.
  • Search restaurants by location, cuisine, or rating.
  • Add your own reviews and images.
  • User authentication and profile customization.
  • And much more!

Installation ๐Ÿ› ๏ธ

  1. Clone this repository:

    git clone https://github.com/djmotor90/project-REST-rant
  2. Navigate to the project folder:

    cd REST-Rant
  3. Install dependencies:

    npm install
  4. Start the application:

    npm start

Now, navigate to http://localhost:3000/ in your browser to start exploring!

Usage ๐Ÿ“

  • Browse Restaurants: Scroll through the homepage to see featured restaurants.
  • Search: Use the search bar to find specific restaurants.
  • Add Reviews: Logged-in users can add reviews to any restaurant listing.

For more examples, please refer to the Documentation

Contributing ๐Ÿค

We welcome contributions from the community! Please read our Contributing Guidelines before submitting a PR.

License ๐Ÿ“

This project is licensed under the terms of the MIT license. For more information, see LICENSE.md.

Contact ๐Ÿ“ง

Feel free to reach out if you have any questions or suggestions!

API Routes

Method Path Purpose
GET / Home page
GET /places Places index page
POST /places Create new place
GET /places/new Form page for creating a new place
GET /places/:id Details about a particular place
PUT /places/:id Update a particular place
GET /places/:id/edit Form page for editing an existing place
DELETE /places/:id Delete a particular place
POST /places/:id/rant Create a rant (comment) about a particular place
DELETE /places/:id/rant/:rantId Delete a rant (comment) about a particular place
GET * 404 page (matches any route not defined above)

Data Colected

Name City State Cuisines Pic
String String String String String

Notes for me enctype="application/x-www-form-urlencoded"

About

https://project-rest-rant-plum.vercel.app


Languages

Language:JavaScript 96.1%Language:CSS 3.9%