Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MS07062000 authored Sep 18, 2023
1 parent 631a20d commit 6954406
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# YelpCamp

Welcome to YelpCamp, a platform for camping enthusiasts to connect, discover campgrounds, and share their camping experiences with a vibrant community.

## Overview

YelpCamp is built using a robust technology stack to provide users with a seamless experience. Here's a brief overview of the key features and technologies used:

### Features

1. **Campground Listings:** Users can explore a wide range of campgrounds, each with detailed information and user reviews.

2. **User Contributions:** Enthusiasts can add their own camps to share with the community, making it a collaborative platform.

3. **Community Engagement:** Connect with fellow outdoor enthusiasts, read and write reviews, and share your camping adventures.

### Technology Stack

The website is developed using the following technologies:

- **HTML:** For structuring web pages.
- **CSS:** For styling and layout.
- **JavaScript:** For interactive features and functionality.
- **Express.js:** A Node.js web application framework for server-side development.
- **Node.js:** A server-side JavaScript runtime.
- **MongoDB:** A NoSQL database for storing and managing data.

## Deployment

You can access the CampingWebsite at the following URL: [YelpCamp](https://yelpcamp-9gsq.onrender.com/)

## Demo

To see how the website works, check out this YouTube video: [YelpCamp Demo](https://youtu.be/gGzljDgcpz0)

## Getting Started

If you want to set up YelpCamp locally for development or testing purposes, follow these steps:

1. Clone the repository: `git clone https://github.com/MS07062000/campingWebsite.git`
2. Navigate to the server directory: `cd server`
3. Install dependencies: `npm install`
4. Start the server: `npm start`
5. Access the website in your browser at `http://localhost:3000`

Feel free to contribute to the project or report any issues on the [https://github.com/MS07062000/campingWebsite/issues](https://github.com/MS07062000/campingWebsite/issues).

Happy camping and exploring the great outdoors with YelpCamp!

0 comments on commit 6954406

Please sign in to comment.