https://github.com/posixpascal/geofind

Multiplayer Geographical Guessing Game using PostGIS, Nuxt, Leaflet & Colyseus.
https://github.com/posixpascal/geofind

colyseus game gameserver leaflet maps nuxt typescript vue websockets

Last synced: 3 months ago
JSON representation

Multiplayer Geographical Guessing Game using PostGIS, Nuxt, Leaflet & Colyseus.

• Host: GitHub
• URL: https://github.com/posixpascal/geofind
• Owner: posixpascal
• License: gpl-3.0
• Created: 2019-09-29T20:30:16.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-06T10:16:05.000Z (7 months ago)
• Last Synced: 2024-08-06T12:11:43.457Z (7 months ago)
• Topics: colyseus, game, gameserver, leaflet, maps, nuxt, typescript, vue, websockets
• Language: Vue
• Homepage: https://geofind.io
• Size: 95 MB
• Stars: 38
• Watchers: 5
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  



[![Maintainability](https://api.codeclimate.com/v1/badges/c81ea928b2b76d4efae5/maintainability)](https://codeclimate.com/github/posixpascal/geofind/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/c81ea928b2b76d4efae5/test_coverage)](https://codeclimate.com/github/posixpascal/geofind/test_coverage)

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

[![Uptime](https://img.shields.io/uptimerobot/ratio/m783620652-575ef546c2e2407fd4bca7d7)](https://status.geofind.io)

[![Status](https://img.shields.io/uptimerobot/status/m783620652-575ef546c2e2407fd4bca7d7)](https://status.geofind.io)

# 🌍 🔍 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.

[Play now!](https://geofind.io)



## 🌈 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:

```bash

# in root directory

yarn install

```

Then start the servers using:

```bash

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](https://github.com/posixpascal/geofind_frontend/blob/master/LICENSE) for more information.

## 📝 Copyright

`geofind.io` is Copyright © 2019 by Pascal Raszyk