Skip to content

Latest commit

 

History

History
147 lines (117 loc) · 6.39 KB

Readme.md

File metadata and controls

147 lines (117 loc) · 6.39 KB

VirtuTour

📋 Table of Contents

  1. 🤖 Introduction
  2. ⚙️ Tech Stack
  3. 🔋 Features
  4. 🤸 Quick Start
  5. 📖 Contributor Guide

🤖 Introduction

VirtuTour app offers an innovative way to explore Texas A&M University by providing an immersive, interactive virtual tour guide experience. As users navigate through the campus, VirtuTour detects their proximity to historic sites and landmarks, automatically presenting rich audio narratives and visual stories that delve into the history and culture of each location. This app is perfect for enhancing the campus visit experience, offering a deep dive into the university's heritage in a modern, engaging way.

react.js

expo

Campus Overview Historical Site Detail View Interactive Tour Experience in Action Interactive Tour Experience in Action

Demo Video

Interactive Tour GIF

⚙️ Tech Stack

  • Node.js
  • React Native
  • Expo
  • Gesture Handler
  • Reanimated
  • Google Maps API

🔋 Features

  • Proximity-Based Narratives: As you approach different landmarks on the campus, the app automatically triggers audio stories and visual content, sharing the history and significance of each location.
  • Immersive Audio Tours: Enjoy captivating audio guides that offer insights into the university's traditions, achievements, and historical milestones.
  • Interactive Campus Map: Utilize an interactive map to navigate the campus efficiently, with highlighted points of interest that guide your journey.
  • Rich Visual Content: Each point of interest is accompanied by a selection of photographs and visual elements that enhance the storytelling experience.
  • Easy Navigation: The app's user-friendly interface ensures a seamless experience as you explore Texas A&M University.

🤸 Quick Start

Follow these steps to set up the project locally on your machine.

Prerequisites

Make sure you have the following installed on your machine:

Cloning the Repository

git clone https://github.com/Sathvik10/VirtuTour.git
cd VirtuTour

Set up development ENV variables

  1. Create a .env.development file in the root folder VirtuTour/VirtuTour/.
  2. Add a Google Maps API key. Set the following env variable: EXPO_PUBLIC_GOOGLE_API_KEY

NOTE: All expo env variables should start with a prefix EXPO_PUBLIC_[name]. name here can be the env variable name

Start the React Native project in Development Mode Run the below command to export application bundle to Android or iOS

NODE_ENV=development npx expo start

Expo Client:

There are two options to setup the Expo Client:

  1. Download an app called Expo Client. Scan the QR code on the app.
  2. Setup the Simulator for Android/IOS

📖 Contributor Guide

Project Structure

VirtuoTour
├── app - Place all the main code in this directory
│   ├── _layout.js
│   ├── home.js
│   └── index.js
├── app.json
├── assets - Place all the assets in this file
│   ├── adaptive-icon.png
│   ├── favicon.png
│   ├── fonts
│   ├── icon.png
│   └── splash.png
├── babel.config.js
├── components - Create components in this directory
│   └── common - Create common components in this directory
│       └── header -
│           └── header.js
├── constants - Create all the constants in this directory
│   ├── icons.js
│   ├── images.js
│   ├── index.js - Export the constants in this file
│   └── theme.js
├── index.js - Entry point is defined in this file
├── package-lock.json
├── package.json
├── styles - Place global styles in this directory
└── yarn.lock

Folder Structuring Tips:

  1. For components that are used throughout the app, such as cards, headers, and footers, place them in the components/common folder. This helps in reusing these components easily.
  2. When creating a new component, organize it into its own folder within components. This folder should include two main files: one for the component's code and another for its styling. This way, you keep both the logic and the look of your component neatly packaged together.

Example:

VirtuoTour
├── components
│   ├── common
│   │   ├── Card
│   │   │   ├── Card.js          - Component logic for a reusable card.
│   │   │   └── Card.styles.js   - Styling for the Card component.
│   │   ├── Header
│   │   │   ├── Header.js        - Component logic for the app header.
│   │   │   └── Header.styles.js - Styling for the Header component.
│   │   └── Footer
│   │       ├── Footer.js        - Component logic for the app footer.
│   │       └── Footer.styles.js - Styling for the Footer component.
│   ├── FeatureComponent
│   │   ├── FeatureComponent.js       - Specific feature component logic.
│   │   └── FeatureComponent.styles.js- Styling specific to the feature component.
│   └── AnotherFeature
│       ├── AnotherFeature.js        - Another specific feature component logic.
│       └── AnotherFeature.styles.js - Styling specific to another feature component.
...