Skip to content

Latest commit

 

History

History
133 lines (83 loc) · 4 KB

README.md

File metadata and controls

133 lines (83 loc) · 4 KB
Raw

Wanderlust - Your Ultimate Travel Blog 🌍✈️

WanderLust is a simple MERN travel blog website ✈ This project is aimed to help people to contribute in open source, upskill in react and also master git.

Preview Image

Figma Design File

Discord Channel

🎯 Goal of this project

At its core, this project embodies two important aims:

  1. Start Your Open Source Journey: It's aimed to kickstart your open-source journey. Here, you'll learn the basics of Git and get a solid grip on the MERN stack and I strongly believe that learning and building should go hand in hand.
  2. React Mastery: Once you've got the basics down, a whole new adventure begins of mastering React. This project covers everything, from simple form validation to advanced performance enhancements. And I've planned much more cool stuff to add in the near future if the project hits more number of contributors.

I'd love for you to make the most of this project - it's all about learning, helping, and growing in the open-source world.

Setting up the project locally

Setting up the Backend

  1. Fork and Clone the Repository

    git clone https://github.com/{your-username}/wanderlust.git

  2. Navigate to the Backend Directory

    cd backend

  3. Install Required Dependencies

    npm i

  4. Set up your MongoDB Database

    • Open MongoDB Compass and connect MongoDB locally at mongodb://localhost:27017.

  5. Import sample data

    To populate the database with sample posts, you can copy the content from the backend/data/sample_posts.json file and insert it as a document in the wanderlust/posts collection in your local MongoDB database using either MongoDB Compass or mongoimport.

    mongoimport --db wanderlust --collection posts --file ./data/sample_posts.json --jsonArray

  6. Configure Environment Variables

    cp .env.sample .env

  7. Start the Backend Server

    npm start

    You should see the following on your terminal output on successful setup.

    [BACKEND] Server is running on port 5000
[BACKEND] Database connected: mongodb://127.0.0.1/wanderlust

Setting up the Frontend

  1. Open a New Terminal

    cd frontend

  2. Install Dependencies

    npm i

  3. Configure Environment Variables

    cp .env.sample .env.local

  4. Launch the Development Server

    npm run dev

Setting up with Docker

  1. Ensure Docker and Docker Compose are Installed

  2. Clone the Repository

 
 git clone https://github.com/{your-username}/wanderlust.git

  1. Navigate to the Project Directory

    cd wanderlust

  2. Update Environment Variables - If you anticipate the IP address of the instance might change, update the .env.sample file with the new IP address.

  3. Run Docker Compose

    docker-compose up

    This command will build the Docker images and start the containers for the backend and frontend, enabling you to access the Wanderlust application.

🌟 Ready to Contribute?

Kindly go through CONTRIBUTING.md to understand everything from setup to contributing guidelines.

💖 Show Your Support

If you find this project interesting and inspiring, please consider showing your support by starring it on GitHub! Your star goes a long way in helping me reach more developers and encourages me to keep enhancing the project.

🚀 Feel free to get in touch with me for any further queries or support, happy to help :)