An open API service indexing awesome lists of open source software.

https://github.com/skyv26/geoexplorer-game


https://github.com/skyv26/geoexplorer-game

Last synced: 10 months ago
JSON representation

Awesome Lists containing this project

README

          

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run Linters](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 🌍 GeoExplorer Trivia Game

> GeoExplorer Trivia Game is an interactive quiz-based application designed to test users' geographical knowledge in a fun and engaging way. The app integrates server-side rendering (SSR) and dynamic hints for a seamless user experience. It utilizes the REST Countries API to fetch trivia data and enables users to explore different difficulty levels while competing for top leaderboard rankings.

## 🛠 Built With

### Tech Stack

> GeoExplorer Trivia Game is a full-stack project built with modern web technologies.

Front-end

Back-end

API

### Key Features

- **Server-Side Rendering** for optimal performance and SEO.
- **Dynamic Hints** such as flags, population, and neighboring countries.
- **Multiple Difficulty Levels** with scoring based on challenge level.
- **Persistent State** using cookies to save scores and progress.
- **Leaderboard Integration** with mock data or API for top scores.
- **Timed Challenges** for additional gameplay dynamics.

(back to top)

## 🚀 Live Demo

> The live demo will be hosted soon. Stay tuned!

- [Live Demo Coming Soon](https://geo-explorer-game.vercel.app/)

(back to top)

## 💻 Getting Started

> Follow the steps below to set up and run the project locally.

### Prerequisites

Before starting, make sure you have:

- Node.js installed on your system.
- A code editor like VS Code.

### Setup

Clone this repository to your desired folder:

```bash
git clone git@github.com:skyv26/GeoExplorer-Game.git geoexplorer-trivia-game
cd geoexplorer-trivia-game
```

### Install

Install the project dependencies:

```bash
npm install
```

### Usage

Run the development server:

```bash
npm run dev
```

The app will be available at `http://localhost:3000`.

### Run Linters

To check for any linting issues:

```bash
npm run lint
```

(back to top)

## 👥 Authors

👨‍💻 **Aakash Verma**

- GitHub: [@skyv26](https://github.com/skyv26)
- Twitter: [@vrma_aakash](https://twitter.com/vrma_aakash)
- LinkedIn: [skyv2022](https://linkedin.com/in/skyv2022)

(back to top)

## 🔭 Future Features

- **Interactive Hints:** Spend coins to unlock extra clues.
- **Session Continuity:** Automatically load saved game progress.
- **Advanced Difficulty Scaling:** Dynamic hints and timers based on difficulty level.

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project, please consider giving it a ⭐️ and sharing your feedback.

(back to top)

## 🙏 Acknowledgements

- ❤️ Inspired by geography and trivia enthusiasts around the world.
- ❤️ Thanks to [REST Countries API](https://restcountries.com/) for providing comprehensive country data.

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)