Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: details about running locally and Netlify deploys #139

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

cben
Copy link

@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.

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
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