This is a quick guide to creating and deploying an Encore + Next.js web app.
🌟 It's a great way to learn how to combine Encore's backend capabilities with a modern web framework, so you can build a more robust and production-ready web app.
Let's go! 🚀
Setup your local dev environment
Install Encore
If this is the first time you're using Encore, you first need to install the CLI that runs the local environment. Use the appropriate command for your system:
-
macOS:
brew install encoredev/tap/encore -
Linux:
curl -L https://encore.dev/install.sh | bash -
Windows:
iwr https://encore.dev/install.ps1 | iex
Create app
When you have installed Encore, create a new Encore application and clone this example:
encore app create my-app --example=nextjs-starter
Running locally
Run your Encore backend:
encore run
In a different terminal window, run the Next.js frontend:
cd frontend
npm install
npm run dev
👉 Open http://localhost:3000 in your browser to see the result.
Encore's Local Development Dashboard
While encore run is running, open http://localhost:9400/ to view Encore's local developer dashboard. Here you can see the request you just made and view a trace of the response.
🤝 Generate a request client and stay type-safe
Keep the contract between the backend and frontend in sync by regenerating the request client whenever you make a change to an Encore endpoint.
npm run gen # Deployed Encore staging environment
# or
npm run gen:local # Locally running Encore backend
🚀 Deploy to the cloud
Encore
Deploy your backend to a staging environment in Encore's free development cloud:
git add -A .
git commit -m 'Initial commit'
git push encore
👉 Then head over to the Cloud Dashboard to monitor your deployment and find your production URL.
From there you can also see metrics, traces, connect your app to a GitHub repo to get automatic deploys on new commits, and connect your own AWS or GCP account to use for deployment.
Next.js on Vercel
- Create a repo and push the project to GitHub
- Create a new project on Vercel and point it to your GitHup repo
- Select
frontendas the root directory for the Vercel project
🚀 Great job - you're done!
You now have a scalable and production-ready web app foundation running in the cloud. 🎉
Now keep building!
If you have questions or want to share your work, join the developers hangout in Encore's community Slack. 👈
CORS configuration
If you are running into CORS issues when calling your Encore API from your frontend then you may need to specify which origins are allowed to access your API (via browsers). You do this by specifying the global_cors key in the encore.app file, which has the following structure:
global_cors: {
// allow_origins_without_credentials specifies the allowed origins for requests
// that don't include credentials. If nil it defaults to allowing all domains
// (equivalent to ["*"]).
"allow_origins_without_credentials": [
"<ORIGIN-GOES-HERE>"
],
// allow_origins_with_credentials specifies the allowed origins for requests
// that include credentials. If a request is made from an Origin in this list
// Encore responds with Access-Control-Allow-Origin: <Origin>.
//
// The URLs in this list may include wildcards (e.g. "https://*.example.com"
// or "https://*-myapp.example.com").
"allow_origins_with_credentials": [
"<DOMAIN-GOES-HERE>"
]
}
More information on CORS configuration can be found here: https://encore.dev/docs/develop/cors
Top comments (0)