Skip to main content
Version: 2.7

Install CODE & DRAW locally

tip

The local installation is only required if you want to run back-ends, or if you want to use coded bricks.

The steps in this tutorial will allow you to:

  • code and run your own bricks locally
  • run Service Apps as back-ends

Prerequisites for installing Olympe​

You will need to have the following installed:

  • Node.js 18 or greater
  • Note: while npm is also needed, it comes directly whenever Node.js is installed
  • Your favorite IDE e.g. Visual Studio Code
  • Git version control system

Install Olympe​

  1. Go to the Olympe Project Template on GitHub
  2. Here the choice is yours: create a new repo from the template, git clone the project or just download it as a .zip
  3. Once you have the repository cloned locally, make sure you are in the community branch: git checkout community
  4. Run the command npm install, and then npm run serve

System details​

  • To stop the server, press Ctrl-C.
  • Closing the terminal window, will also stop the process.
  • Restart it with the "npm run serve" command.

Start composing with DRAW​

  • In your browser, open this url http://localhost:8888/
  • Authenticate with your Community credentials
  • See that your Community projects are present

That's all!
You can now take a look at our guides and tutorials, and start building a first app and add a first coded function.

Also, take a look at the README.md file for more details on the local commands.

Launch a Service App as a back-end service​

If you have a Service App and want to run it as an actual node.js back-end process, these are the steps to follow:

  1. Get the tag (the Olympe unique identifier) of the Service App from the context menu of the Service App:

    Get the tag of the service app

  2. Then use it as the value of the parameter sc.app in the file res/oConfigNode.js of your project:

    {
      "sc.app": "<your application tag>"
    }

    Example:

    {
      "sc.app": "018722493753c408c7dd"
    }

  3. Finally, run your service application using the following command:

    npm run serve:node

Updating your setup after a new Olympe release​

When a new release occurs, your package.json file also needs to be updated. For instance, when release 2.2.2 was out, the following changes had to be made to update the olympe dependencies in the setup's package.json file:

@olympeio/draw: 2.2.2,
@olympeio/runtime-web: 9.2.1,
@olympeio/runtime-node: 9.2.1,
@olympeio/dev-tools:2.2.0
@olympeio/core: 2.2.3

All versions are published on npmjs.com.

Fetch these package.json dependencies info automatically​

  • Simply generate a new project from scratch inside a different folder using the steps above.
  • Copy-paste the lines from the package.json to get the latest versions of the dependencies.
  • Run npm install in your project.