TimeHub

Analyse the entire story of your Github repo in a timeline.

Built in the #meleeton2017

• Running Locally
• Contributing
• Helpers/Tools
• Maintainers

Running locally

Clone the repository

git clone --depth=1 git@github.com:uesteibar/timehub.git

Install dependencies

cd timehub
yarn

Install MongoDB

You also need to create a .env file and add GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET. The reason for this is that we do too many requests to import a repo and we would otherwise exceed the rate limit.

Run the server

yarn start

Go to http://127.0.0.1:3000/:username/:repo Keep in mind that in the first load we import all the date we need and it might take quite long depending on the size of the project :)

Contributing

The project uses standard-version to update the CHANGELOG with each commit message and upgrade the package version. For that reason every contribution should have a title and body that follows the conventional-changelog-standard conventions.

So this is a step by step guide to contributing to the project (mostly extracted from the standard-version docs):

1. when you land commits on your master branch, select the Rebase and Merge option.
2. add a title and body that follows the conventional-changelog-standard conventions.
3. when you're ready to release a new version:
4. git checkout master; git pull origin master
5. run npm run deploy

Helpers/Tools

• Changelog
• Code of conduct
• Code style
• commitizen: A cli that will prompt the author to fill out any required commit fields at commit time. For this project we would use the cz-conventional-changelog adapter.
• conventional-changelog-standard
• cz-conventional-changelog
• standard-version

Maintainers

• @uesteibar