Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/alexlamper/geoname

GeoName is an interactive web application built with Next.js with the main functionality of allowing the users to guess geographical locations and flags.
https://github.com/alexlamper/geoname

Last synced: 14 days ago
JSON representation

GeoName is an interactive web application built with Next.js with the main functionality of allowing the users to guess geographical locations and flags.

Awesome Lists containing this project

README

        

# 🌍 GeoName

Welcome to **GeoName** – Your Online Geographical Placename Learning Platform.

---

## About GeoName

I created GeoName as my first 'startup' in the creation of 6 startups in 6 months. When is something a startup? Idk
GeoName is a web-based platform designed to help people learn about different geographical places, flags, and more. Whether you're a beginner or already have a lot of geographical knowledge, GeoName provides quizzes and learning resources to elevate your journey.

---

## πŸ“œ Table of Contents

1. [Features](#features)
2. [Tech Stack](#tech-stack)
3. [Pages](#pages)
4. [API](#api)
5. [Contributing](#contributing)
6. [Support](#support)
7. [License](#license)
8. [Version](#version)
9. [FAQ](#faq)
10. [Contact](#contact)

---

## 🌟 Features

- **User Profiles**: Create and personalize your profile to showcase your progress and achievements.
- **Geographical Quizzes**: Test your knowledge of places and flags through fun, interactive quizzes.
- **Leaderboards**: Compete with other users, track your rankings, and celebrate your achievements.
- **Progress Tracking**: Monitor your quiz performance, achievements, and learning milestones.
- **Mobile-Friendly Design**: Learn on any device, anywhere.
- **Interactive Maps**: Discover the world with dynamic maps powered by Leaflet, making learning immersive and engaging.

---

## πŸ’» Tech Stack

GeoName uses modern technologies for optimal performance and user experience:

- **Next.js (TypeScript)**: Primary framework for building the app, providing server-side rendering, static site generation, and scalability.
- **Stripe**: Secure payment processing for future premium features.
- **Vercel**: Hosting and deployment platform optimized for Next.js applications.
- **ShadCN**: UI styling library for modular and accessible components, ensuring a cohesive design.
- **TailwindCSS**: Utility-first CSS framework for rapid, consistent styling.
- **Leaflet**: JavaScript library for interactive maps, allowing customizable layers and markers.
- **Overpass API**: Accesses OpenStreetMap's geographical data for quizzes and educational content.
- **Clerk**: Provides secure authentication with multi-method login support.
- **React-Icons**: Extensive icon library to improve visual consistency in the UI.

---

## πŸ“„ Pages

- **Dashboard**: Overview of your progress, including completed quizzes, achievements, and leaderboard position.
- **Places**: Explore world locations with quizzes on cities, landmarks, and more.
- **Flags**: Test your knowledge of country flags.
- **Leaderboard**: See your ranking, motivating you to improve and climb the ranks.
- **Profile**: Customize your profile, view achievements, and track your learning journey.
- **About**: Learn more about GeoName's mission and goals.
- **Help**: Access FAQs and resources for any questions or support.

---

## 🌐 API

GeoName uses the **Overpass API** for retrieving up-to-date geographical data, such as place names and boundaries, directly from OpenStreetMap. For more information on available data, check out the [Overpass API documentation](https://wiki.openstreetmap.org/wiki/Overpass_API).

---

## 🀝 Contributing

GeoName welcomes contributions! Here’s how you can contribute:

1. **Fork the repository** and create a new branch.
2. **Make your changes** and add descriptive commit messages.
3. **Submit a pull request** detailing your improvements or fixes.

Every contribution helps make GeoName better for everyone! πŸŽ‰

---

## ❀️ Support

If you’d like to support my work, sharing GeoName with others or contributing to development would be greatly appreciated!

---

## πŸ“„ License

This project is licensed under the [MIT License](LICENSE), allowing for reuse and modification with attribution.

---

## πŸ“Œ Version

Current Version: **v1.0**

---

## ❓ FAQ

**Q: Is GeoName free to use?**
A: Yes! GeoName is free for everyone. Certain premium features may be added in the future.

**Q: What data sources are used for geographical information?**
A: GeoName uses OpenStreetMap data through the Overpass API for accurate, up-to-date information.

**Q: How do I report a bug or suggest a feature?**
A: Please open an issue on our GitHub repository with details of your suggestion or bug report.

---

## πŸ“¬ Contact

Got questions, feedback, or just want to say hi? Reach out at [[email protected]](mailto:[email protected]).

Thanks for checking out **GeoName**! 🌍