Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gr2m/milestones
A GitHub backed Milestone thingy
https://github.com/gr2m/milestones
Last synced: about 4 hours ago
JSON representation
A GitHub backed Milestone thingy
- Host: GitHub
- URL: https://github.com/gr2m/milestones
- Owner: gr2m
- Created: 2014-07-19T22:53:29.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-03-05T06:42:00.000Z (over 3 years ago)
- Last Synced: 2024-04-16T05:57:15.308Z (7 months ago)
- Language: JavaScript
- Homepage: http://gr2m.github.io/milestones/
- Size: 359 KB
- Stars: 69
- Watchers: 10
- Forks: 14
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-starred - gr2m/milestones - A GitHub backed Milestone thingy (others)
README
Milestones
==========
> A GitHub Api backed Milestone thingy
Local Setup
-----------
```
git clone [email protected]:gr2m/milestones.git
cd milestones
npm install
bower install
grunt serve
```
How it works
------------
This is a static HTML5 app that loads issues from a repo right
from the [GitHub API](https://developer.github.com/).
The repo is currently hardcoded in `src/js/app.js`, but can easily
be changed by changing `repoUrl = 'https://github.com/gr2m/milestones'`
as you like.
For performance reasons, the response to the GitHub API is cached
locally. That way the app can be shown right after page load. Once
the request is finished, the local cache gets updated and the app
will be rerendered.
The app has a few assumptions on milestones, issues & labels of the repo.
1. All Milestones set their owner in the first line of their description.
The actual description is then separated by `---`. Here is an example
```
owner: gr2m
---
Actual Description here
```
2. All Milestones will be sorted alphabetically. You can prefix the milestone
titles with numbers and a space, e.g. `01 My First Milestone`. The `01 ` part
will automatically be removed
3. To mark an issue as active, add the `active` label.
4. To add efforts to issues, create labels that must start with a number,
like `1 easy` or `3 hard`. Add only one effort-label per issue.
TODOs
-----
- allow to dynamically pass another github repo url
- make it work offline
Fine Print
----------
Milestones have been authored by [Gregor Martynus](https://github.com/gr2m),
proud member of the [Hoodie Community](http://hood.ie/).
License: MIT