diff --git a/docs/get-started/installation.mdx b/docs/get-started/installation.mdx index 435b1d614..f40ad067a 100644 --- a/docs/get-started/installation.mdx +++ b/docs/get-started/installation.mdx @@ -6,7 +6,7 @@ description: 'Basic installation instructions for the Nitric Framework' ## Prerequisites -Nitric relies on functionality from the following projects to help retrieve plugins, containerize and deploy your application. +Nitric relies on functionality from the following projects to help retrieve plugins, containerize, and deploy your application. Please follow these links to the official installation steps for each. - [Git](https://git-scm.com/) @@ -15,9 +15,9 @@ Please follow these links to the official installation steps for each. - [Pulumi](https://www.pulumi.com/docs/cli/) _(for deployments, only needed if using the default providers)_ - When setting up docker on Linux be sure to follow the [post-installation + When setting up Docker on Linux be sure to follow the [post-installation steps](https://docs.docker.com/engine/install/linux-postinstall/) so you can - run docker as a non-root user. + run Docker as a non-root user. ## Installing the Nitric CLI @@ -93,5 +93,5 @@ You can view the CLI release notes on our [CLI GitHub Releases page](https://git ## What's next -- Start building with the [quick start guide](./get-started/quickstart). -- Checkout out the [foundations](/foundations/why-nitric) section for a more detailed introduction to Nitric. +- Start building with the [quick start guide](/get-started/quickstart). +- Checkout out the [foundations](/get-started/foundations/why-nitric) section for a more detailed introduction to Nitric. diff --git a/docs/get-started/quickstart.mdx b/docs/get-started/quickstart.mdx index de48515cd..63ba26874 100644 --- a/docs/get-started/quickstart.mdx +++ b/docs/get-started/quickstart.mdx @@ -37,7 +37,7 @@ curl -L "https://nitric.io/install?version=latest" | bash For more installation options and dependency information review the full - [installation guide](/getting-started/installation). + [installation guide](/get-started/installation). ## Using the `new` command @@ -118,8 +118,8 @@ npm install cd hello-world # We recommend using [Pipenv](https://pipenv.pypa.io/en/latest/) for dependency and virtual environments -# We have included it in our python templates. -# Installation instructions: https://pipenv.pypa.io/en/latest/installation/#preferred-installation-of-pipenv +# We have included it in our python templates. +# Installation instructions: https://pipenv.pypa.io/en/latest/installation/#preferred-installation-of-pipenv pipenv install --dev ``` @@ -226,7 +226,7 @@ Your project should now look like this: ## Running your app -Nitric provides a local development server offering emulated versions of cloud services, suitable for local development/testing. You can use the Nitric CLI to start the local server using the `nitric start` command. +Nitric provides a local development environment offering emulated versions of cloud services, suitable for local development/testing. You can use the Nitric CLI to start your application and the local environment using the `nitric start` command. ```bash nitric start @@ -234,47 +234,27 @@ nitric start Nitric will automatically run your application using the service start script, this is located in your `nitric.yaml`. -After your service is running, it will register itself with the server. All the APIs are locally hosted on their own port, which will be displayed in the CLI output as `http://localhost:`. +```yaml title:nitric.yaml +name: example +services: + - match: services/*.ts + start: npm run dev:services $SERVICE_PATH +``` + +All the APIs are locally hosted on their own port, which will be displayed in the CLI output as `http://localhost:`. -The output will also show the local dashboard URL, the dashboard will automatically refresh with API details and other useful tools for building your application. +The output will also show the [local dashboard](/get-started/foundations/projects/local-development#local-dashboard) URL, the dashboard will automatically refresh with details about your resources and tools to interact with each of them. -Once the API is registered, you can test the API using any HTTP client, your browser, or the [local dashboard](/getting-started/local-dashboard): +Once the API is registered, you can test the API using any HTTP client, your browser, or the [local dashboard](/get-started/foundations/projects/local-development#local-dashboard): ```bash curl http://localhost:4001/hello/John Hello John ``` -## Your local dashboard - -Access the [local development dashboard](./local-dashboard) by opening the URL and port displayed in the CLI output. - -The development dashboard is a powerful tool designed to help you move faster when developing new features. With the API explorer, you can easily access automatically generated endpoints and path params. Additionally, the Schedules Explorer allows you to trigger your schedules with ease, making it easier than ever to stay on top of your tasks. Make the most of your local development process with this essential tool. - -Watch this brief video to see the development dashboard in action. You'll get a firsthand look at how the dashboard streamlines your development process by showcasing the [debugging](/guides/nodejs/debugging) of APIs and schedules in the popular code editor, VS Code. - -
-
-