Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 2.08 KB

README.md

File metadata and controls

64 lines (42 loc) · 2.08 KB

Wareg - Warung Rekomendasi

Wareg is a web platform designed to make it easy for users to rate and review local eateries. The name "Wareg" is derived from "Warung Rekomendasi," reflecting its purpose of recommending and reviewing local places to eat. The platform allows users to provide star ratings, write reviews, and contribute new eateries to the community.

Figma: https://www.figma.com/file/5FCYPczRMDvx3at56THaKF/War%C3%A9g?type=design&node-id=0%3A1&mode=design&t=KzCQm29CdB8Unygt-1

Features

1. Rating and Reviews

  • Users can rate eateries on a scale of 1 to 5 stars.
  • Detailed review sections allow users to share their experiences and recommendations.

2. Add New Eateries

  • Users have the option to add new local eateries to the platform.
  • Submission includes basic information about the place, such as name, address, and category.

3. Next.Js TypeScript Implementation

  • The website is built using Next.Js, providing a smooth and efficient user experience.
  • TypeScript ensures type safety and enhances development productivity.

Getting Started

Follow these steps to set up Wareg locally:

  1. Clone the Repository:

    git clone https://github.com/dzakwanIrfan/wareg-app.git
  2. Install Dependencies:

    cd wareg-app
    npm install
  3. Run the Development Server:

    npm run dev

    Open http://localhost:3000 in your browser to access Wareg locally.

Usage

  • Browse and explore local eateries listed on the platform.
  • Rate and review your favorite places.
  • Contribute by adding new eateries to help the community grow.

Technologies Used

  • Next.Js: A React-based web framework for building modern web applications.
  • TypeScript: Adds static typing to the JavaScript language, catching common errors during development.

Contributing

We welcome contributions! If you'd like to contribute to Wareg, please follow our Contribution Guidelines.

License

This project is licensed under the MIT License.


Happy Eating with Wareg! 🍔🌮🍜