Skip to content

docs: update step 3 to match the current init value #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: update step 3 to match the current init value #1

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
edf8f92
docs: update step 3 to match the current init value
ImBIOS Aug 4, 2024
885d6b2
Update README.md
ImBIOS Aug 7, 2024
55006e6
Update README.md
ImBIOS Aug 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,18 @@ npm install # Install dependencies
encore app init # Create a new Encore application. Take note of the App ID
```

3. Add `"lang": "typescript"` to the `encore.app` file to enable TypeScript support.
3. If not automatically added. Add `"lang": "typescript"` to the `encore.app` file to enable TypeScript support.
Your `encore.app` file should look like this:

```json
{
"name": "<APP_ID>",
"lang": "typescript"
"id": "<APP_ID>",
"lang": "typescript",
"build": {
"docker": {
"bundle_source": true
}
}
}
```

Expand Down Expand Up @@ -72,7 +77,7 @@ Here you can see the request you just made and a view a trace of the response.
Keep the contract between the backend and frontend in sync by regenerating the request client whenever you make a change
to an Encore endpoint.

In the `gen` npm scripts, replace `next-js-test-ts-9wvi` with the ID of your Encore application.
In the `gen` npm scripts, replace `{{ENCORE_APP_ID}}` with the ID of your Encore application.

```bash
npm run gen # Will create a new request client frontend/app/lib/client.ts
Expand Down