Quick Start Guide

Get started with Encore in minutes

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

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 app, using the app name you picked.

cd your-app-name

Then while in the app root directory, run your app.

encore run

You should see this:

$ encore run
Running on http://localhost:4000
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:4000/hello/world
{"Message": "Hello, world!"}

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

You can now access your local development dashboard by opening http://localhost:4000 in your browser. Here you can monitor logs, view traces, and explore the automatically generated API documentation.

Deploy your app

By default your application deploys to Encore's cloud, which is free to use for development and hobby projects.

Deploy your application by running:

git push encore

You now have an app running in the cloud. Congratulations! 🚀

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

What's next?

If you're looking for ideas on what to do next, check out the REST API tutorial.

If you want to chat to others building with Encore or need help, join our friendly community on Slack.