Code Monkey home page Code Monkey logo

geofind's Introduction

Maintainability Test Coverage License: GPL v3 Uptime Status

๐ŸŒ ๐Ÿ” 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!

๐ŸŒˆ 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 install

Then 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

geofind's People

Contributors

posixpascal avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.