Giter Club home page Giter Club logo

wanderlust's Introduction

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

๐ŸŽฏ 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
  1. Navigate to the Backend Directory
cd backend
  1. Install Required Dependencies
npm ci
  1. Set up your MongoDB Database

    • Open MongoDB Compass and connect MongoDB locally at mongodb://localhost:27017.
  2. 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
  1. Configure Environment Variables
cp .env.sample .env
  1. Start the Backend Server
npm start

You should see Server is running on port 5000 on your terminal output.

Setting up the Frontend

  1. Open a New Terminal
cd frontend
  1. Install Dependencies
npm ci
  1. Configure Environment Variables
cp .env.sample .env.local
  1. Launch the Development Server
npm run dev

๐ŸŒŸ 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 :)

wanderlust's People

Contributors

krishnaacharyaa avatar hemant14050 avatar sankalpharitash21 avatar chinmaykunkikar avatar jjinendra3 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.