CONTRIBUTING.md

Contributing

Welcome 👋 ! We glad to see that you are interested in contributing to GeoGuess.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Geoguess Principe

1. GeoGuess is an open-source game
2. GeoGuess is free
3. GeoGuess is decentralized. Anyone can install its game server without any dependence on this repository
4. GeoGuess keep in mind to have an educational goal

Development

You need to configure Google Maps Platform and Firebase to make game work. See the instructions below.

• Google Maps API
• Firebase
• Firebase Realtime Database

Once you get an API key and register the project with Firebase, copy .env.dist named .envand replace all variables.

cp .env.dist .env

Download Node.js here if you don't have and make sure you can run npm from the terminal.

# install dependencies
npm install

# Run the project
npm run serve

# build for production
npm run build

Pull Request Process

1. Make sure npm test passes
2. Comments PR : We don't have rules about the PR description, just clearly explain what you have done

Transalation

Update translation : https://translate.geoguess.games/

• Add translation file in src/lang/locale following en.json

• Add the language in :

  • src/lang/index.js

import ru from './locale/ru.json'; // 1

Vue.use(VueI18n);

const translations = {en, ja, fr, cs, de, ru}; // 2


export const languages = [
    {
        text: 'English',
        value: 'en',
    },
    {// 3
        text: 'русский',
        value: 'ru',
    }
];

* `src/plugins/vuetify.js`

// 1 
import ru from 'vuetify/es5/locale/ru';

export default new Vuetify({

    lang: {
        locales: { en, fr, ja, cs, de, ru },// 2
    },

* `src/plugins/countryNamePlugin.js`

import countries from 'i18n-iso-countries';
countries.registerLocale(require(`i18n-iso-countries/langs/en.json`));
countries.registerLocale(require(`i18n-iso-countries/langs/ru.json`));