RomainHer / maps.gg

Flutter App with a map to see video game tournaments around (based on start.gg API)
2 stars 0 forks source link

Maps.gg

Maps.gg is a mobile application built with Flutter that helps users find esports and fighting game tournaments on an interactive map, using data from the start.gg API. A first version of the app will soon be available on the Google Play Store.

Overview

Maps.gg assists esports and fighting game enthusiasts in locating tournaments near them or in specific regions using start.gg data. Start.gg is a comprehensive platform for organizing and participating in gaming tournaments, providing tools for registration, score tracking, and bracket management, widely used by esports communities around the world. The app is build with a simple, intuitive interface, users can explore available tournaments, view event details, and easily navigate to discover the competitions that interest them.

Features

Technologies Used

Installation and Local Deployment

To clone and run the project locally:

  1. Clone this repository:

    With HTTPS

    git clone https://github.com/RomainHer/maps.gg.git
    

    With SSH

    git clone git@github.com:RomainHer/maps.gg.git
  2. Enter the project directory:

    cd maps.gg
  3. Install Flutter dependencies:

    flutter pub get
  4. Get your own API token from start.gg

    1. Go to start.gg
    2. Create an account
    3. Go to Developer Settings > Personal Access Tokens to create your token
  5. Put your token in a .env file

    1. Copy the .env.exemple file and rename it .env
    2. Copy your token for START_GG_API_TOKEN

      START_GG_API_TOKEN=put_your_token_here
  6. Check if you have all the necessary tools

    flutter doctor
  7. Check if you have any devices or emulators available

    flutter devices
    flutter emulators
  8. Run the app on a simulator or physical device:

    flutter run

    NOTE: if the "Running Gradle task 'assembleDebug'..." takes too long, you can try to run flutter clean and then flutter run again. Or go to the android folder and run ./gradlew clean and then flutter run again.

Screenshots

Screenshot 1

Contributions

Contributions are welcome! If you'd like to contribute, please open an issue to discuss potential changes before creating a pull request.

Contact

For any questions or suggestions, feel free to contact me via email, discord, or connect with me on LinkedIn.

Thank you for using Maps.gg! Enjoy discovering and joining esports tournaments near you.