Skip to content

README: details about running locally and Netlify deploys#139

Open
cben wants to merge 2 commits intopomber:masterfrom
cben:readme-build-deploy
Open

README: details about running locally and Netlify deploys#139
cben wants to merge 2 commits intopomber:masterfrom
cben:readme-build-deploy

Conversation

@cben
Copy link
Copy Markdown

@cben cben commented Jul 12, 2019

Hi.
These details are pretty easy to discover, but might help contributors.

The instructions for Netlify on a fork are perhaps overkill, most people won't need that (is this clear from the text? Or is it unnecessarily scaring?). I just wanted to document yarn build command and build directory settings, but feel free to drop that.

Comment thread readme.md
yarn install
yarn start

it'll open the starting page in browser, you'll want to append the path that comes after `https://github.com/`
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't complete formulating this sentence perhaps.
But the reason this needs clarification in the first place, is that starting page always says "2. Replace github.com with github.githistory.xyz". Ideally it'd use current domain, e.g. "2. Replace github.com with localhost:3000" or "2. Replace github.com with deploy-preview-139--github-history.netlify.com".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant