Skip to main content

OVERVIEW

Welcome to NAVIGO!

NAVIGO is a location-based adventure game designed for university students. It encourages players to explore the campus, complete quests, uncover hidden markers, and earn digital rewards such as badges and collectibles. Whether you're a developer, contributor, or curious user, this documentation will guide you through understanding, setting up, and extending NAVIGO.

With NAVIGO, your campus experience becomes interactive and gamified — combining learning, exploration, and friendly competition.

Why NAVIGO?​

  • Engage Students: Turn routine campus visits into interactive challenges.
  • Learn & Explore: Discover new areas, buildings, and hidden landmarks.
  • Compete & Collaborate: Track scores, complete quests with friends, and climb the leaderboard.
  • Reward Achievements: Earn digital badges and collectibles for completing milestones.
  • Admin Management: Administrators can manage quests, monitor players, and update rewards.

This documentation provides everything from installation instructions to advanced API usage, ensuring developers can contribute efficiently and users can make the most of NAVIGO’s features.

Key Features​

  • Quests & Challenges: Players complete location-based tasks across campus.
  • Interactive Map: Locate hidden markers with Google Maps integration.
  • Rewards System: Earn badges, collectibles, and achievements for milestones.
  • Leaderboard: Track top performers and encourage friendly competition.

Technology Stack​

  • Frontend: Vite, TypeScript, React.js, Tailwind CSS, shadcn-ui
  • Backend: Node.js, Express.js
  • Database: Firebase Firestore (real-time data storage)
  • Authentication: Firebase Auth
  • External API: Google Maps API for location verification
  • Hosting: Netlify
  • Documentation: Docusaurus
  • Testing: Jest & JSDOM

Development Methodology​

NAVIGO is developed using Agile and SCRUM principles:

  • Iterative sprints with stand-ups and reviews
  • Continuous integration with version control via Git
  • Regular testing and code quality checks

Who Can Use This Documentation​

  • Students / Players: Learn how to play NAVIGO, complete quests, and earn rewards.
  • Developers / Contributors: Understand the codebase, extend features, and maintain the project.
  • Administrators: Manage quests, track engagement, and reward achievements.

What You'll Need​

Ensure you have the following installed:

  • Node.js version 18 or above
    • During installation, select all recommended options to include essential dependencies.
  • A code editor like VS Code for editing files efficiently.
  • Git to clone the repository and manage version control.
  • Firebase account for Authentication and Firestore setup
  • Google Maps API key for location verification

Documentation Site​

We use Docusaurus, a modern documentation framework, to create and manage NAVIGO’s documentation. It is fast, customizable, and integrates smoothly with React for interactive components.