Quickstart

This quickstart is intended for intermediate to advanced developers. It only gets you up and running with Actyx. For a gentler intro to Actyx, head to the Chat Tutorial.

Before starting, make sure you have git and Node.js installed on your computer.

1. Install and start Actyx on your computer

Windows

• Download Actyx for Windows
• Double click and run through the installer
• Start Actyx via the Start Menu; a tray icon will appear

Linux

• Download Actyx for Linux (64 bit)
• Open a terminal, navigate to your downloads folder and run the following command chmod +x actyx; ./actyx

macOS

• Download Actyx for Mac
• Open a terminal and run the following command cd ~/Downloads; chmod +x actyx-mac; ./actyx-mac

tip

If you do not get asked for your password, you have to explicitly allow Actyx:

1. Go to Settings and then to Security & Privacy. In the General tab, you should see a prompt at the bottom that asks you to allow Actyx CLI.
2. When running the first ax command, you will be prompted again to allow the Actyx CLI.

2. Now download and set up the quickstart project by running npm init actyx quickstart

$ npm init actyx quickstart
✔ Loaded starter project
✔ Installed dependencies
Type 'cd quickstart && npm run start' to run

3. Once the set up is done, navigate into the quickstart directory and run it with npm run start

$ cd quickstart
$ npm run start

> [email protected] start
> ts-node index

Hello, World!
Hello 1!
Hello 2!

If you see messages starting with "Hello" pop up, everything is working! Press Ctrl+C to shutdown the process.

Error ECONNREFUSED 127.0.0.1:4454

If you get this error please double-check that Actyx is actually running on your computer.

4. Now you are ready to start programming on Actyx

Try editing the code in the index.ts file. Then save your changes and restart the node process.

What's next?

• Figure out how to build on Actyx with practical how-to guides
• Learn about the fundamentals by reading the conceptual guides

Need help?

If you have any issues, you are welcome to post in the Community Forum or join our Discord chat.