Add support for optional local backend #474
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add support for and document running against a local GitHub proxy server instead of against the live branch on GitHub.com. This is a beta feature of Netlify CMS: https://www.netlifycms.org/docs/beta-features/#working-with-a-local-git-repository
|
View a preview of the Design System website with your changes using the following link. Built with commit f772b88 |
contolini
approved these changes
May 2, 2020
There was a problem hiding this comment.
I love this idea and think we should enable it by default with yarn start. It solves the annoyance of local testing modifying the live repo.
Instead of npx I'd recommend:
- Installing the proxy as a dev dependency by running
yarn add netlify-cms-proxy-server --devfrom thedocs/directory - Adding a new script called something like start-netlify. (Note: the proxy has to be run from the git repo's root, hence the
cd ../) - Adding that new script to the start script.
Our package.json scripts are starting to get a bit too messy for my comfort but I don't think that should delay this PR.
|
@contolini thanks, that's a great improvement! It runs locally for me using just |
|
Yeeeee |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add support for and document running against a local GitHub proxy server instead of against the live branch on GitHub.com.
This is a beta feature of Netlify CMS:
https://www.netlifycms.org/docs/beta-features/#working-with-a-local-git-repository
I've pushed this commit to master on my fork, and you can see that my fork's GH pages edit buttons still try to authenticate to GitHub.com; but if you run this branch locally, it will use the local proxy server, but only if is running. If you're not running a local proxy server, local development still falls back to the GitHub backend.
Per the netlify-cms code, the CMS only looks for the local proxy if running on localhost.
I don't love the recommendation of
npxto run random code from npm. Is there a better way to do this?