Welcome to Wanderlust 2024! 🌟 This project aims to provide a comprehensive platform for travel enthusiasts, offering features such as map integration 🗺️, user-generated content ✍️, and a seamless experience for discovering new destinations.
Live Link: https://wanderlust-2024-tkqf.onrender.com/listing
- 🤝 How to Contribute
- 🛠️ How to Set Up the Project Locally
- 📬 Contact
We welcome contributions to help improve Wanderlust 2024! 🚀 Here’s how you can get involved:
-
Fork the Repository 🍴
- Navigate to the Wanderlust 2024 GitHub page. 🌐
- Click on the Fork button in the top-right corner of the page to create a copy of the repository in your GitHub account. ➕
-
Clone Your Forked Repository 🔄
- After forking, clone the repository to your local machine:
git clone https://github.com/your-username/Wanderlust-2024.git
- Navigate to the project directory:
cd Wanderlust-2024
- After forking, clone the repository to your local machine:
-
Create a New Branch for Your Changes 🌿
- Create a new branch for your feature or fix:
git checkout -b feature/your-feature-name
- Create a new branch for your feature or fix:
-
Make Your Changes ✏️
- Add your desired features, fix bugs, or improve documentation. 🛠️
-
Add Your Changes to the Staging Area 📦
- Stage the files you modified or created:
git add .
- Stage the files you modified or created:
-
Commit Your Changes 📝
- Commit your changes with a descriptive message:
git commit -m "Add [feature/fix] - description"
- Commit your changes with a descriptive message:
-
Push Your Changes ⬆️
- Push the changes to your forked repository:
git push origin feature/your-feature-name
- Push the changes to your forked repository:
-
Clone the Repository 🔍
- Clone the repository to your local machine:
git clone https://github.com/your-username/Wanderlust-2024.git
- Clone the repository to your local machine:
-
Navigate to the Project Directory 📂
- Change to the directory where the project is located:
cd Wanderlust-2024
- Change to the directory where the project is located:
-
Set Up Your Mapbox Account 🌐
- Go to Mapbox and sign up for a free account. 🆓
- After logging in, navigate to the Tokens section under your account settings. 🔑
- Create a new Access Token and copy it. You will need this for the
.env
file. 📄
-
Set Up Your Cloudinary Account ☁️
- Go to Cloudinary and sign up for a free account. 🆓
- After logging in, navigate to your Dashboard. 📊
- Copy your Cloud Name, API Key, and API Secret. You will need these for the
.env
file. 🔐
-
Ensure
.env
andnode_modules/
Are in.gitignore
🛡️- Before proceeding, ensure that both
.env
andnode_modules/
are added to your.gitignore
file to prevent sensitive information and large files from being uploaded to GitHub. 🚫 - If they are not already there, add them:
echo .env >> .gitignore echo node_modules/ >> .gitignore
- Before proceeding, ensure that both
-
Create a
.env
File 🗃️- In the root directory of the project, create a
.env
file and add the following variables:MAP_TOKEN=your-mapbox-access-token ATLAS_DB_TOKEN=your-mongodb-connection-uri # mongodb://127.0.0.1:27017/wanderlust for running mongodb server locally SECRET=your-secret-key CLOUD_NAME=your-cloudinary-cloud-name CLOUD_API_KEY=your-cloudinary-api-key CLOUD_API_SECRET=your-cloudinary-api-secret PORT=8080 # Default port for the server
- In the root directory of the project, create a
-
Install Dependencies ⚙️
- Install the required Node.js dependencies:
npm install
- Install the required Node.js dependencies:
-
Start the Server 🚀
- You have two options to start the server:
- Using
npx nodemon
for auto-restarting:npx nodemon
- Or using
node app.js
to start the server manually:node app.js
- Using
- You have two options to start the server:
-
Environment Setup 🔒
- Ensure that the
.env
file is not uploaded to GitHub by checking that.gitignore
includes.env
. 📜 The following code snippet prevents.env
from being deployed if you're running in development mode:if (process.env.NODE_ENV !== 'production') { require('dotenv').config(); }
- Ensure that the
Feel free to raise issues and contribute to the repository! 🎉💻
We're excited to have you on board! Whether you're a seasoned developer or just starting out, your skills and ideas can make a significant impact on Wanderlust 2024. Here’s how you can get involved:
- Share Your Ideas 💡: Have a feature in mind? Let us know!
- Fix Bugs 🐛: Help us improve the project by identifying and fixing issues.
- Enhance Documentation 📚: Clear documentation helps everyone. Your contributions can make it even better!
Every contribution, big or small, is valued and appreciated. Together, we can create an amazing platform for travel enthusiasts! 🌍✨
For questions or feedback, feel free to reach out via GitHub issues or contact the project maintainers. ✉️