Skip to content

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. ✈️✨ (If the below link is not working check readme for live link)

Notifications You must be signed in to change notification settings

Soujanya2004/wanderlust-2024

Repository files navigation

🌍 Wanderlust-2024

WL

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

πŸ“š Table of Contents

  • 🀝 How to Contribute
  • πŸ› οΈ How to Set Up the Project Locally
  • πŸ“¬ Contact

🀝 How to Contribute

We welcome contributions to help improve Wanderlust 2024! πŸš€ Here’s how you can get involved:

  1. 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. βž•
  2. 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
  3. Create a New Branch for Your Changes 🌿

    • Create a new branch for your feature or fix:
      git checkout -b feature/your-feature-name
  4. Make Your Changes ✏️

    • Add your desired features, fix bugs, or improve documentation. πŸ› οΈ
  5. Add Your Changes to the Staging Area πŸ“¦

    • Stage the files you modified or created:
      git add .
  6. Commit Your Changes πŸ“

    • Commit your changes with a descriptive message:
      git commit -m "Add [feature/fix] - description"
  7. Push Your Changes ⬆️

    • Push the changes to your forked repository:
      git push origin feature/your-feature-name

πŸ› οΈ How to Set Up the Project Locally

  1. Clone the Repository πŸ”

    • Clone the repository to your local machine:
      git clone https://github.com/your-username/Wanderlust-2024.git
  2. Navigate to the Project Directory πŸ“‚

    • Change to the directory where the project is located:
      cd Wanderlust-2024
  3. 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. πŸ“„
  4. 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. πŸ”
  5. Ensure .env and node_modules/ Are in .gitignore πŸ›‘οΈ

    • Before proceeding, ensure that both .env and node_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
  6. 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
      
  7. Install Dependencies βš™οΈ

    • Install the required Node.js dependencies:
      npm install
  8. 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
  9. 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();
      }

Feel free to raise issues and contribute to the repository! πŸŽ‰πŸ’»

🀝 Join Our Community of Contributors!

Wanderlust Logo

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! 🌍✨

πŸ‘€ Our Valuable Contributors πŸ’–βœ¨

πŸ“¬ Contact

For questions or feedback, feel free to reach out via GitHub issues or contact the project maintainers. βœ‰οΈ

❀️ Made with Love by Soujanya

Your Profile

Thank You for Your Support! πŸ’–

Your contributions help us grow and improve! Happy Coding βœ¨πŸš€

Contributors Animation

About

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. ✈️✨ (If the below link is not working check readme for live link)

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published