Repository files navigation

Hi everyone!

This is a standalone server for the javascript tutorialhttps://javascript.info.

You can use it to run the tutorial locally and translate it into your language.

Windows, Unix systems and macOS are supported. For Windows, you'll need to call scripts with ".cmd" extension, that are present in the code alongside with Unix versions.

1. InstallGit andNode.js.

   These are required to update and run the project.For Windows just download and install, otherwise use standard OS install tools (packages or whatever convenient).

   (Maybe later, optional) If you're going to change images, please installImageMagick, use packages for Linux or homebrew/macports for MacOS.

2. Install global Node modules:

   npm install -g bunyan gulp@4

3. Create the root folder.

   Create a folder/js for the project.

   You can also use another directory as the root, then change the paths below: replace/js with your root.

4. Clone the tutorial server into it:

   cd /jsgit clone https://github.com/javascript-tutorial/servergit clone https://github.com/javascript-tutorial/engine server/modules/engine

   Please note, there are two clone commands. That's not a typo:modules/engine is cloned from another repository.

   And please don't forget when pulling an updated server code:modules/engine needs to be pulled too.

5. Clone the tutorial text into it.

   The repository starts with the language code, e.g for the French versionfr.javascript.info, for Russian –ru.javascript.info, for Chinesezh.javascript.info etc.

   The English version isen.javascript.info.

   The tutorial text repository should go into therepo subfolder, like this:

   cd /js/server/repogit clone https://github.com/javascript-tutorial/en.javascript.info

6. Run the site

   Install local NPM modules:

   cd /js/servernpm install

   Run the site with the./edit command with the language argument. Above we cloneden tutorial, so:

   ./edit en

   This will import the tutorial from/js/server/repo/en.javascript.info and start the server.

   Wait a bit while it reads the tutorial from the disk and builds static assets.

   Then access the site athttp://127.0.0.1:3000.

   To change the port, set thePORT environment variable:

   # Runs the server at http://127.0.0.1:8080PORT=8080 ./edit en

   For Windows, read the note about environment variables below.

7. Edit the tutorial

   As you edit text files in the tutorial text repository (cloned at step 5),the webpage will reload automatically.

For Windows, to pass environment variables, such asPORT, you can installnpm i -g cross-env and prepend calls withcross-env, like this:

cd /js/servercross-env PORT=8080 ./edit en

In the examples below, the commands are withoutcross-env, prepend it please, if you're on Windows.

Alternatively, you can use other Windows-specific ways to set environment variables, such as a separateset PORT=8080 command.

The server uses English by default for navigation and design.

You can set another language it with the second argument ofedit.

E.g. if you clonedru tutorial, it makes sense to useru locale for the server as well:

cd /js/server./edit ru ru

Please note, the server must support that language. There must be corresponding locale files for that language in the code of the server, otherwise it exists with an error. As of now,ru,en,zh,tr,ko andja are fully supported.

Please don't translate SVG files manually.

They are auto-generated from the English variant, with the text phrases substituted fromimages.yml file in the repository root, such ashttps://github.com/javascript-tutorial/ru.javascript.info/blob/master/images.yml.

So you need to translate the content ofimages.yml and re-generate the SVGs using a script.

Here are the steps to translate images.

Step 1. Setup git upstream (if you haven't yet) and pull latest changes from English version:

cd /js/server/repo/zh.javascript.info# in the tutorial foldergit remote add upstream https://github.com/javascript-tutorial/en.javascript.infogit fetch upstream master

Step 2. Createimages.yml with translations in the repository root.

An example of such file (in Russian):https://github.com/javascript-tutorial/ru.javascript.info/blob/master/images.yml

The file format isYAML.

Here's a quote:

code-style.svg:# image file name"No space":# English stringtext:"Без пробелов"# translationposition:"center"# (optional) "center" or "right" - to position the translated string"between the function name and parentheses":position:"center"text:"между именем функции и скобками"

As you can see, for each image file there's a name (such ascode-style.svg), and then goes the list of its English phrases (such as"No space"), accompanied by translations:

• text is the translated text
• position (not always needed, details will come soon) is the relative position of the text.

Initially, the file may be empty, then you can fill it with images one by one.

Only the mentioned images will be translated.

Step 3. Use the helper script to get a list of strings to translate:

The script is executed from the server root, like this:

# Adjust NODE_LANG to your language❯ NODE_LANG=zh npm run gulp -- engine:koa:tutorial:imageYaml --image code-style.svg

Here's an example of its output:

code-style.svg:'2':''No space:''between the function name and parentheses:''between the parentheses and the parameter:''Indentation:''2 spaces:'''A space':''after for/if/while…:'''} else { without a line break':''Spaces around a nested call:''An empty line:''between logical blocks:''Lines are not very long:''A semicolon ;:''is mandatory:''Spaces:''around operators:''Curly brace {:''on the same line, after a space:''A space:''between:''arguments:''A space between parameters:''

As we can see, the script returns a text snippet that can be inserted intoimages.yml fully or partially.

E.g. like this:

code-style.svg:'A space':'Пробел'

Or like this, if we want to position the translation in the center (see below for more examples):

code-style.svg:'A space':position:'center'text:'Пробел'

Step 4. Run the translation task:

cd /js/server# in the server folder# adjust NODE_LANG to your languageNODE_LANG=zh npm run gulp -- engine:koa:tutorial:figuresTranslate

This script checks out all SVG images fromupstream (English version) and replaces the strings inside them according toimages.yml. So they become translated.

The new translated SVGs are the tutorial folder now, but not committed yet.

You can see them withgit status.

Take a moment to open and check them, e.g. in Chrome browser, just to ensure that the translation looks good.

P.S. If an image appears untranslated on refresh, force the browser to "reload without cache" (hotkeys).

Step 5. Then you'll need togit add/commit/push the translated SVGs, as a part of the normal translation flow.

...And voilà! SVGs are translated!

Normally, the translation script looks for all images listed inimages.yml.To translate a single image, use the--image parameter of the script:

# replace strings only in try-catch-flow.svgNODE_LANG=zh npm run gulp -- engine:koa:tutorial:figuresTranslate --image try-catch-flow.svg

Read on for more advanced options and troubleshooting.

For the positioning to work, sure you have installedImageMagick mentioned in theinstallation step.

By default, the translated string replaces the original one, starting in exactly the same place of the image.

Before the translation:

| hello world

After the translation (你 is at the same place whereh was, the string is left-aligned):

| 你好世界

Sometimes that's not good, e.g. if the string needs to be centered, e.g. like this:

     |hello world     |

Here, the "hello world" is centered between two vertical lines|.

Then, if we just replace the string, it would become:

     |你好世界     |

As we can see, the new phrase is shorter. We should move it to the right a bit.

Theposition: "center" inimages.yml does exactly that.

It centers the translated string, so that it will replace the original one and stay "in the middle" of the surrounding context.

Here's the text withposition: "center", centered as it should be:

   |你好世界   |

Theposition: "right" makes sure that the translated string sticks to the same right edge:

hello world |    你好世界 |

That's also useful for images when we expect the text to stick to the right.

The replacement script only operates on strings, not other graphics, so a long translated string may not fit the picture.

Most pictures have some extra space for longer text, so a slight increase doesn't harm.

If the translated text is much longer, please try to change it, make it shorter to fit.

If the translated text absolutely must be longer and doesn't fit, let me know, we'll see how to adjust the picture.

If you add a translation toimages.yml, but after running the script the SVG remains the same, so that the translation doesn't "catch up":

1. Ensure that you have the latest server code and translation repos, fetched the upstream.
2. Check if the English version has the file with the same name. The file could have been renamed.
3. Check that there's only 1 file with the given name in the tutorial. Sometimes there may be duplicates.
4. Check that the translated string inimages.yml is exactly as in SVG: use the helper script (Step 3) to extract all strings.

If it still doesn't work –file an issue.

If you'd like to edit the server code (assuming you're familiar with Node.js),not the tutorial text, then there are two steps to do.

First, run the command that imports (and caches) the tutorial:

cd /js/serverNODE_LANG=en npm run gulp engine:koa:tutorial:import

For Windows:npm i -g cross-env and prepend the call withcross-env to pass environment variables, like this:

cd /js/servercross-env NODE_LANG=en...

Afterwards, call./dev <server language> to run the server:

cd /js/server./dev en

Running./dev uses the tutorial that was imported and cached by the previous command.

It does not "watch" tutorial text, but it reloads the server after code changes.

Again, that's for developing the server code itself, not writing the tutorial.

Please ensure you have Node.js version 10+ (node -v shows the version).

If it still doesn't work –file an issue. Please mention OS and Node.js version.

Please pull the very latest git code and install latest NPM modules before publishing an issue.

The server's tools useinotify by default on Linux to monitor directories for changes. In some cases there may be too many items to monitor.

! Samples code below work correctly for Ubuntu.

You can get your current inotify files watch limit by:

$> cat /proc/sys/fs/inotify/max_user_watches

When this limit is not enough to monitor all files, you have to increase the limit for the server to work properly.

You can set a new limit temporary by:

$> sudo sysctl fs.inotify.max_user_watches=524288$> sudo sysctl -p

It is very important that you refer to the documentation for your operating system to change this parameter permanently.

--
Yours,
Ilya Kantor
iliakan@javascript.info