Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.

docs: Add port configuration for local config #647

Merged
merged 4 commits into from
Oct 21, 2024
Merged

docs: Add port configuration for local config #647

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8f1bd36
Add port configuration for local config.
tjholm Oct 21, 2024
1753ff8
capitilize Configuration header
tjholm Oct 21, 2024
13f12db
add simple example.
tjholm Oct 21, 2024
09aabe7
Bold local dashboard bullet titles.
tjholm Oct 21, 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
20 changes: 20 additions & 0 deletions docs/get-started/foundations/projects/local-development.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,23 @@ Many of these features make it possible to build and testing modules of your app
All features provide real-time updates, ensuring you stay in sync with your application changes.

To access the Development Dashboard open the local URL in your browser. By default, the URL is set to [http://localhost:49152](http://localhost:49152).

## Configuration

The local development experience can be configured using a `local.nitric.yaml` file.

A full example with example configuration is shown below:

```yaml
apis:
# 👀 Configure an API named "main" to run on port 6001
# e.g. const mainApi = api("main");
main:
port: 6001

websockets:
# 👀 Configure a WebSocket named "ws" to run on port 6002
# e.g. const ws = websocket("ws");
ws:
port: 6002
```
Loading