Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 3.9 KB

CONTRIBUTING.md

File metadata and controls

80 lines (56 loc) · 3.9 KB
Raw

Contributing to Hedy

Help Hedy with translations

Hedy is now available in Dutch, French, English, Brazilian Portugese and Spanish, but we'd love to support more languages!

If you would like to add a new translation, there are four places where files that need to be translated:

  1. The folder level-defaults has a file for each language. That file controls what the landing page for each levels looks like. It is probably easiest to copy the English file, rename it and translate that. Tip: example variables can be translated too, that is probably helpful for learners!

  2. In the folder texts there is a file for each language too. That file translate UI-elements like menu headers, and, important, the error messages Hedy programmers will see. As above, copying the English file and translate that.

  3. The folder main controls the web pages around Hedy. start holds the content of the start page, and there is a page with press, and with contact info too. If you want to, you can skip those pages (people will then see the English version)

  4. There is also a folder with extra instructions for each of the levels. While not mandatory, the docs in this section are of help for kids to better explore each level.

Translated all of that?

Two more small things to do!

  1. Add your language to the menu.

  2. Now go to app.py and add your language to this list:

ALL_LANGUAGES = {
    'en': 'English',
    'nl': 'Nederlands',
    'es': 'Español',
    'fr': 'Français',
    'pt_br': 'Português',
    'de': 'Deutsch',
    'it': 'Italiano'
}

In some places, we are missing translations to the existing language. You can find those locations as issues

Run Hedy code on your machine

If you are going to contribute to the code of Hedy, you will probably want to run the code on your own computer. For this you need to install Python 3.6 or higher. Then, here's how to get started once you have downloaded or cloned the code:

$ python3 -m venv .env
$ source .env/bin/activate
(.env)$ pip install -r requirements.txt

If you want to run the website version locally, run:

(.env)$ python app.py

If you don't want to use a website, you can run the code locally without the need of a website. To create a file use:

$ touch FILENAME.hedy

If you use a higher level than 1, specify the level at the top of the file by typing #LEVEL 1-8. This will let the interpreter know which level you want to run the code on. Now to acctually run the code, type the following command in the terminal:

(.env)$ python runhedy.py FILENAME.hedy

If all did correctly, you will see the output of your code right into the terminal.

If you don't want to specify the level itself in the file, you can use the --level argument after the filename. You can do it like this:

(.env)$ python runhedy.py FILENAME.hedy --level 1-8

When you execute this, the interpreter will use the specified level.

Pre-release environment

When you have your PR accepted into master, that version will be deployed on hedy-alpha.herokuapp.com.

We do periodic deploys of master to the production version of Hedy.