Skip to content

Project for the Leap Hackathon at lablab.ai from 4 to 7 March 2023

Notifications You must be signed in to change notification settings

Jaweria-B/Leap_Hackathon_Project

 
 

Repository files navigation

Virtual Urban Explorer (VUE) 🌆🔍

Virtual Urban Explorer (VUE) is a cutting-edge platform that brings urban exploration to your fingertips. By leveraging advanced technologies, VUE offers an immersive, interactive, and up-to-date virtual experience of cities worldwide. Say goodbye to traditional limitations and embark on a journey to explore urban environments like never before! 🏙️✨

Overview 🌐

Virtual Urban Explorer (VUE) revolutionizes the concept of urban exploration by providing users with a dynamic, real-time, and interactive experience of cities across the globe. With VUE, users can immerse themselves in the sights, sounds, and culture of cities from the comfort of their own homes. Whether you're planning a trip, conducting research, or simply curious about new destinations, VUE offers a unique way to explore and engage with urban environments. 🗺️🚀

Key Features 🔑

Dynamic Exploration 🔄

Experience cities in real-time, with updates reflecting current events, weather conditions, and urban changes. Whether you're planning a trip or simply curious about a new city, VUE keeps you informed and up-to-date. 🌤️🔄

Accessibility ♿

Explore any city from anywhere, overcoming physical, financial, and mobility barriers. With VUE, the world is at your fingertips, allowing you to discover new destinations and cultures without leaving your home. 🌍🌐

Interactive Engagement 🎮

Participate in virtual tours, scavenger hunts, and other interactive activities that make exploration fun and engaging. Connect with fellow explorers, share your experiences, and discover hidden gems in cities around the globe. 🕵️‍♂️🎉

Educational Value 📚

Learn about the history, culture, and architecture of cities in an engaging and interactive manner. Whether you're a student, a traveler, or a lifelong learner, VUE offers insights and information to satisfy your curiosity. 🏛️📖

Prerequisites 🛠️

Before getting started with VUE, ensure you have the following tools installed:

  • Git - v2.13 or greater
  • NodeJS - v16 or greater
  • npm - v6 or greater

Getting Started 🚀

Follow these steps to run VUE in your development environment:

  1. Clone the repository: git clone https://github.com/FaisalRajpoot1/codmak.git
  2. Navigate to your application directory: cd YOUR_APPLICATION
  3. Install dependencies: npm install
  4. Start the development server: npm start

Configuration ⚙️

Configure your environment variables in the .env file:

  • REACT_APP_GOOGLE_MAP_ID: Your Google Map ID

Folder Structure 📂

Get familiar with the project structure:

.
├── package.json
├── postcss.config.js
├── public
│   ├── assets
│   │   ├── images     # All Project Images
│   │   └── fonts      # Project fonts
│   ├── favicon.ico
│   ├── index.html
│   ├── manifest.json
│   └── robots.txt
├── README.md
├── src
│   ├── App.jsx
│   ├── components     # UI and Detected Common Components
│   ├── constants      # Project constants
│   ├── hooks          # Helpful Hooks
│   ├── index.jsx
│   ├── pages          # All route pages
│   ├── Routes.jsx     # Routing
│   ├── styles
│   │   ├── index.css  # Other Global Styles
│   │   └── tailwind.css  # Default Tailwind modules
│   └── util
│       └── index.jsx  # Helpful utils
└── tailwind.config.js  # Entire theme config, colors, fonts etc.

Available Scripts 📜

Explore the available scripts provided by VUE:

  • npm start: Runs the app in the development mode.
  • npm test: Launches the test runner in the interactive watch mode.
  • npm run build: Builds the app for production to the build folder.
  • npm run eject: Ejects the project configuration (Note: This is a one-way operation).

Installation of Dependencies 📦

You can easily install additional dependencies using npm or yarn. For example:

npm install --save react-router

or

yarn add react-router

Contributing 🤝

We welcome contributions to enhance Virtual Urban Explorer! If you have any suggestions, ideas, or bug reports, please feel free to open an issue or submit a pull request.


Explore Virtual Urban Explorer and embark on an adventure to discover the world's cities from the comfort of your own home! Let's explore together, virtually. 🌍✨

About

Project for the Leap Hackathon at lablab.ai from 4 to 7 March 2023

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 94.7%
  • CSS 4.1%
  • HTML 1.2%