Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.
Merged
Changes from all commits
Commits
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
38 changes: 29 additions & 9 deletions docs/get-started/foundations/projects/local-development.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,18 +52,38 @@ If you need to use a custom certificate and key, you can place them in the `.nit

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:

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

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.

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