You can use it to run the tutorial locally and translate it into your language.
(If you have an old copy of the English tutorial, please rename
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 install GraphicsMagick.
Install global Node modules:
npm install -g bunyan gulp
Create the root folder.
Create a folder
/jsfor the project. You can use any other directory as well, just adjust the paths below.
Clone the tutorial server into it:
Clone the tutorial text into it.
The text repository has
"-language"postfix at the end, e.g for the French version
fr, for Russian –
For the Russian version:
Run the site
Run the site with the same language:
Please note that the argument of
editis exactly the language you cloned at step 5.
Wait a bit while it reads the tutorial from disk and builds static assets.
Then access the site at
Edit the tutorial
As you edit text files in the tutorial text repository (cloned at step 5), the webpage gets reloaded automatically.
If you'd like to edit the server code, not the tutorial text (assuming you're familiar with Node.js), run this once:
./dev uses the cached version of the tutorial, 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.
If something doesn't work – file an issue.
Please mention OS and Node.js version.