https://github.com/uesteibar/timehub
Analyze the entire story of your Github repo in a timeline
https://github.com/uesteibar/timehub
Last synced: 2 months ago
JSON representation
Analyze the entire story of your Github repo in a timeline
- Host: GitHub
- URL: https://github.com/uesteibar/timehub
- Owner: uesteibar
- License: mit
- Created: 2017-04-21T20:25:42.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-04-30T11:42:09.000Z (about 8 years ago)
- Last Synced: 2025-01-11T11:47:40.169Z (4 months ago)
- Language: JavaScript
- Homepage: http://timehub.uesteibar.com/uesteibar/timehub
- Size: 191 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# TimeHub
[]()
[]()
[](https://codeclimate.com/github/uesteibar/timehub)
Analyse the entire story of your Github repo in a timeline.
Built in the #meleeton2017
- [Running Locally](#running-locally)
- [Contributing](#contributing)
- [Helpers/Tools](#helperstools)
- [Maintainers](#maintainers)
## Running locally
Clone the repository
```bash
git clone --depth=1 [email protected]:uesteibar/timehub.git
```
Install dependencies
```bash
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
```bash
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:
1. `git checkout master; git pull origin master`
2. run `npm run deploy`
## Helpers/Tools
- [Changelog](https://github.com/uesteibar/timehub/blob/master/CHANGELOG.md)
- [Code of conduct](https://github.com/uesteibar/timehub/blob/master/CHANGELOG.md)
- [Code style](https://npm.im/prettier)
- [commitizen](https://github.com/commitizen/cz-cli): 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](https://github.com/conventional-changelog/conventional-changelog) adapter.
- [conventional-changelog-standard](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md)
- [cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog)
- [standard-version](https://github.com/conventional-changelog/standard-version)
## Maintainers
- [@uesteibar](https://github.com/uesteibar)