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

Commit e26fd0d

Browse files
authored
docs: Add port configuration for local config (#647)
1 parent d12b8e5 commit e26fd0d

File tree

1 file changed

+29
-9
lines changed

1 file changed

+29
-9
lines changed

docs/get-started/foundations/projects/local-development.mdx

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,18 +52,38 @@ If you need to use a custom certificate and key, you can place them in the `.nit
5252

5353
The Nitric CLI also hosts a Local Development Dashboard, which provides a graphical interface for interacting with your application during development. The dashboard includes the following features:
5454

55-
- Architecture: An automatic architecture visualization of your application, including all services, resources and their connections.
56-
- API Explorer: An automatic HTTP client for testing your APIs.
57-
- Batch jobs: Observe batch service jobs and submit tasks.
58-
- Databases: View your SQL databases and interact with them using SQL queries. This screen can also be used to trigger database migrations.
59-
- Schedules: Trigger and observe scheduled tasks.
60-
- Storage: View your applications buckets and interact with them, including uploading and downloading files.
61-
- Topics: View topics and subscriptions, and publish messages to topics.
62-
- Secrets: View and manage your application secrets.
63-
- WebSockets: Dive deep into connection details, connecting, and sending messages.
55+
- **Architecture**: An automatic architecture visualization of your application, including all services, resources and their connections.
56+
- **API Explorer**: An automatic HTTP client for testing your APIs.
57+
- **Batch jobs**: Observe batch service jobs and submit tasks.
58+
- **Databases**: View your SQL databases and interact with them using SQL queries. This screen can also be used to trigger database migrations.
59+
- **Schedules**: Trigger and observe scheduled tasks.
60+
- **Storage**: View your applications buckets and interact with them, including uploading and downloading files.
61+
- **Topics**: View topics and subscriptions, and publish messages to topics.
62+
- **Secrets**: View and manage your application secrets.
63+
- **WebSockets**: Dive deep into connection details, connecting, and sending messages.
6464

6565
Many of these features make it possible to build and testing modules of your application in isolation. For example, you can could create and test a topic and subscriber without needing to first write the publisher.
6666

6767
All features provide real-time updates, ensuring you stay in sync with your application changes.
6868

6969
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).
70+
71+
## Configuration
72+
73+
The local development experience can be configured using a `local.nitric.yaml` file.
74+
75+
A full example with example configuration is shown below:
76+
77+
```yaml
78+
apis:
79+
# 👀 Configure an API named "main" to run on port 6001
80+
# e.g. const mainApi = api("main");
81+
main:
82+
port: 6001
83+
84+
websockets:
85+
# 👀 Configure a WebSocket named "ws" to run on port 6002
86+
# e.g. const ws = websocket("ws");
87+
ws:
88+
port: 6002
89+
```

0 commit comments

Comments
 (0)