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.

Sign up for GitHub

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

Jump to bottom

README: details about running locally and Netlify deploys #139

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

README: details about running locally and Netlify deploys #139

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f9ecb7
README: details about running locally and Netlify deploys
cben Jul 12, 2019
87aae1b
Fix lint, Document testing & lint ;-)
cben Jul 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 36 additions & 1 deletion readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Quickly browse the history of files in any git repo:

[Try it](https://github.githistory.xyz/babel/babel/blob/master/packages/babel-core/test/browserify.js)

> If you like this project consider [backing my open source work on Patreon!](https://patreon.com/pomber)
> If you like this project consider [backing my open source work on Patreon!](https://patreon.com/pomber)
> And follow [@pomber](https://twitter.com/pomber) on twitter for updates.

## Extensions
Expand Down Expand Up @@ -44,6 +44,41 @@ javascript: (function() {

You can use Git History for local git repos with the [CLI](https://github.com/pomber/git-history/tree/master/cli) or with the [VS Code extension](https://marketplace.visualstudio.com/items?itemName=pomber.git-file-history).

## Hacking

To run from local checkout:

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


### Testing & linting

yarn test

It stays running watching for source changes, press <kbd>w</kbd> for help, <kbd>q</kbd> to quit.

If it says "Code style issues found in the above file(s). Forgot to run Prettier?", run:

yarn format

### Netlify deploys

Once you submit a PR to `pomber/git-history` repo, Netlify will try to build it a deploy a publicly accessible preview domain such as https://deploy-preview-137--github-history.netlify.com/.
To get the preview URL, look for "deploy/netlify Deploy preview ready!" line, click on "Details" link to its right.
It will also get updated on each push to the PR branch.

If you want to set up hosting and public previews for branches of your fork _before_ you submit a PR:

1. Go to https://app.netlify.com/.
2. Login with GitHub.
3. Click "New site from Git" button.
It'll likely prompt you to give Netlify some access to your repos.
4. Choose your fork of this repo.
5. Under "Build & deploy" settings, set Build command to `yarn build` and Publish directory to `build`.
6. Under "Deploy contexts", configure which branches to build.

## Support Git History

### Sponsors
Expand Down