Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/balramapply/wanderlust

Wanderlust is a full-stack MARN stack application designed to provide a platform similar to Airbnb
https://github.com/balramapply/wanderlust

atlas bootstrap cloudinary css ejs ejs-mate expressjs html javascipt javascript mongodb multer multer-storage mvc-framework nodejs password render

Last synced: 3 months ago
JSON representation

Wanderlust is a full-stack MARN stack application designed to provide a platform similar to Airbnb

Awesome Lists containing this project

README

        

## 🌏 Wanderlust

![Wanderlust Logo](./assets/home.png)

---



Overview


Wanderlust is a full-stack MARN stack application designed to provide a platform similar to Airbnb, where users can search for accommodations, make bookings, and leave reviews. With a sleek and intuitive interface, Wanderlust aims to make finding and booking your next adventure easy and enjoyable.

---



Table of Contents


---
- [📑 Features](#-features)
- [🔧 Technologies](#-technologies)
- [⚙️ Installation](#-installation)
- [🚀 Usage](#-usage)
- [📸 Screenshots](#-screenshots)
- [🤝 Contributing](#-contributing)
- [📜 License](#-license)
- [📞 Contact](#-contact)

---

## 📑 Features

- User authentication and authorization
- View detailed listings with photos, descriptions, and reviews
- Make bookings and manage reservations
- Post and view reviews of accommodations
- Responsive design for seamless experience on all devices

---

## 🔧 Technologies

### Front-end
- **HTML**: displayed in a web browser.
- **CSS**: describing the presentation.
- **Bootstrap**: A front-end framework.
- **JavaScript**: frontend and backend development.
- **EJS**: HTML markup with plain JavaScript.

### Back-end
- **Node.js**: server-side scripting.
- **Express.js**: framework for Node.js
- **MongoDB**: Database
- **Passport**: authenticate requests.
- **MVC Freamwork**: used to structure the backend.

### Hosting
- **Cloudinary**: entire image management pipeline.
- **Multer**: primarily used for uploading files.
- **Atlas**: MongoDB Atlas is a fully-managed cloud database.
- **Render**: Deploy Our Project

---

## ⚙️ Installation

1. **Clone the repository**
```bash
git clone https://github.com/yourusername/wanderlust.git
cd wanderlust
```

2. **Install dependencies**
```bash
npm install
cd client
npm install
cd ..
```

3. **Set up environment variables**
Create a `.env` file in the root directory and add the following:
```env
CLOUD_NAME=cloude_name
CLOUD_API_KEY=cloud_api_key
CLOUD_API_SECRET=cloud_api_secret
ATLASDB_URL=atlas_db
SECRET=secret
```

4. **Run the application**
```bash
npm run dev
```

---

## 🚀 Usage

1. **Register and log in** to access all features.
2. **Creating Listings** by entering a Various Fields.
3. **View accommodation details** including photos, descriptions, and reviews.
4. **Updating Listing** Anything that you want to updates
5. **Leave a review** after your stay.

---

## 📸 Screenshots

![Homepage](./assets/home.png)
*Homepage*

![Search Results](./assets/login.png)
*Log In*

![Listing Details](./assets/signup.png)
*Sign Up*

![Listing Details](./assets/listing.png)
*Listing*

![Listing Details](./assets/review.png)
*Review*

---

## 🤝 Contributing

Contributions are welcome! Please fork the repository and create a pull request with your changes. Ensure your code follows the project's coding standards and include relevant tests.

1. Fork the repository
2. Create your feature branch
```bash
git checkout -b feature/YourFeature
```
3. Commit your changes
```bash
git commit -m 'Add YourFeature'
```
4. Push to the branch
```bash
git push origin feature/YourFeature
```
5. Open a pull request

---

## 📜 License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

---

## 📞 Contact

For any questions or suggestions, please reach out to:

- **Name**: Balram
- **Email**: [email protected]
- **GitHub**: [BalramApply](https://github.com/BalramApply)

---

*Happy wandering with Wanderlust!*