🌍 🔍 geofind.io
geofind.io is a multiplayer geographical guessing game written exclusively in TypeScript featuring different game modes, custom markers, fine-tuned settings and lots of other features.
🌈 Screenshots
🕹 Game Play
📍 Home
👥 Lobby
💄 Profile
🏛 Structure
The project is structured using yarn workspaces. The following namespaces exist at the moment:
- packages/web: Nuxt powered web client
- packages/api: Colyseus GameServer API
- packages/app: ReactNative powered mobile client
🚀 Up and running
To install geofind on your local machine, follow the instructions listed below.
First, install the dependencies listed in the package.json file:
# in root directory
yarn installThen start the servers using:
yarn workspace @geofind/api start:dev
yarn workspace @geofind/web start:dev🔨 Database
This project depends on a PostgreSQL with PostGIS extension. A database dump is located in this repo under config/dumps for your convenience.
🗺 Tileserver
The frontend expects 2 URLs to a tileserver (see: ./packages/web/.env.example). You may specify your own tileserver but it's not necessary for the application to start.
🤝 Contribution
Contribution is very much appreciated and every pull request will be considered for merging into master.
👨⚖️ License
This project is licensed under GNU GPLv3. View LICENSE for more information.
📝 Copyright
geofind.io is Copyright © 2019 by Pascal Raszyk