Speedrun

Get started with Encore quickly


Install the Encore CLI

To work with Encore you need our command-line utility. Install by running the appropriate command for your system.

Mac OS:

brew install encoredev/tap/encore

Windows:

iwr https://encore.dev/install.ps1 | iex

Linux:

curl -L https://encore.dev/install.sh | bash

Make sure Docker is installed and running

To create Encore applications with databases, you need Docker installed and running. If you haven't already, install Docker before proceeding.

Create your app

Create your app by running:

encore app create

Then press Enter to create your free account, following instructions on screen.

Coming back to the terminal, pick a name for your app.

Then select the Hello World app template.

Run your app locally

Open the folder created for your application. (Note: Your App ID will be different)

cd hello-world-4x3b

Then while in the app root directory, run your app by running the command:

encore run

You should see this:

$ encore run
Running on http://localhost:4060
9:00AM INF registered endpoint endpoint=World service=hello

While you keep the app running, open a separate terminal and call your API endpoint:

$ curl http://localhost:4060/hello.World
{"Message": "Hello, world!"}

You've successfully created and run your first Encore application. Well done!

You can now monitor logs, view traces, and access API documentation by opening http://localhost:4060 in your browser.

Deploy your app

Deploying your app to the cloud is as easy as running:

git push encore

Wow, you now have an app running in the cloud, congratulations!

Now head to the Encore web application where you can see production logs and traces, manage environments and configure the cloud hosting of your choice.

Join the conversation on Slack

If you're looking for ideas on what to do next or need help, join our friendly community on Slack.