Skip to content
This repository was archived by the owner on Sep 12, 2019. It is now read-only.

Commit 8787181

Browse files
author
sw-yx
committed
add localdev notes
1 parent b920eb2 commit 8787181

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

README.md

+21-15
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ Netlify CLI plugin for local dev experience. [If you're interested to work on Ne
1414
Netlify Dev brings the power of Netlify's Edge Logic layer, [serverless functions](#netlify-functions) and [add-on ecosystem](#using-add-ons) to your local machine. It runs Netlify's production routing engine in a local dev server to make all redirects, proxy rules, function routes or add-on routes available locally and injects the correct environment variables from your site environment, installed add-ons or your netlify.toml file into your build and function environment.
1515

1616
```
17-
┌───────────────┐
18-
│ Project │
19-
│ │
20-
└localhost:5000─┘
21-
22-
23-
┌──────────┐ │
24-
│ Addons ├────┐ ▼
17+
┌───────────────┐
18+
│ Project │
19+
│ │
20+
└localhost:5000─┘
21+
22+
23+
┌──────────┐ │
24+
│ Addons ├────┐ ▼
2525
└──────────┘ │ ┌localhost:5000─┐ ┌──────────────┐
2626
┌──────────┐ └───▶│ │ │ │
2727
│functions ├────────▶│ Netlify │ │ Browser │
2828
└──────────┘ ┌───▶│ Dev │ │ │
2929
┌──────────┐ │ │ │ │ │
3030
│_redirects│────┘ └──localhost:8888───▶ localhost:8888─┘
31-
└──────────┘
31+
└──────────┘
3232
```
3333

3434
With project detectors, it automatically detects common tools like Gatsby, Hugo, React Static, Eleventy, and more, to give a zero config setup for your local dev server and can help scaffolding new functions as you work on them. Read our blogpost for [more on detectors and how you can contribute](https://www.netlify.com/blog/2019/04/24/zero-config-yet-technology-agnostic-how-netlify-dev-detectors-work/)!
@@ -266,11 +266,17 @@ For now, it is important to include instructions to create addons for each membe
266266
267267
Thanks for contributing! You'll need to follow these steps to run Netlify CLI and `netlify-dev-plugin` locally:
268268

269-
0. uninstall any globally installed versions of `netlify-cli`
270-
1. clone and install deps for https://github.com/netlify/cli
271-
1. `npm link` from inside the `cli` folder
272-
1. clone and install deps for this repo
273-
1. inside the `netlify-dev-plugin` folder, run `yarn link`
274-
1. inside the `cli` folder, run `yarn link "netlify-dev-plugin"`
269+
1. uninstall any globally installed versions of `netlify-cli`
270+
2. clone and install deps for https://github.com/netlify/cli
271+
3. `npm link` from inside the `cli` folder
272+
4. clone and install deps for this repo
273+
5. inside the `netlify-dev-plugin` folder, run `yarn link`
274+
6. inside the `cli` folder, run `yarn link "netlify-dev-plugin"`
275275

276276
Now you're both ready to start testing `netlify dev` and to contribute to the project! Note these are untested instructions, please get in touch if you're unable to follow them clearly and we'll work with you. Or ping [@swyx](https://twitter.com/swyx).
277+
278+
Note that code that you may be debugging or investigating may be in some transitive dependencies we have published as separate libraries:
279+
280+
- https://github.com/netlify/netlify-rules-proxy/ ([npm](https://www.npmjs.com/package/@netlify/rules-proxy))
281+
- https://github.com/netlify/node-redirects-parser ([npm](https://www.npmjs.com/package/netlify-redirect-parser))
282+
- (not open source) https://www.npmjs.com/package/netlify-redirector

0 commit comments

Comments
 (0)