https://github.com/lfilho/team-index
Index of teams and people
https://github.com/lfilho/team-index
Last synced: 9 months ago
JSON representation
Index of teams and people
- Host: GitHub
- URL: https://github.com/lfilho/team-index
- Owner: lfilho
- License: mit
- Created: 2015-04-12T20:41:49.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-05-11T22:08:33.000Z (over 10 years ago)
- Last Synced: 2025-03-17T11:52:09.121Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 442 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
team index
====
[](http://travis-ci.org/joshwnj/team-index)
See [the test cases](./tests/index.js) for example usage.
Installation
----
First, install iojs. Using a recent version of nvm:
```
nvm install iojs
nvm use iojs
```
And then:
```
npm install
gem install sass
```
Configuration
----
1. Duplicate `.env.example` and `.email-whitelist.json.example`
2. Remove the `.example` suffix of each one
3. Change theirs contents accordingly (note: they are safely gitignored).
Running the web server
----
```
npm run build-watch &
iojs .
```
See [[Team Index]] docs in [./index.js](./index.js) for more info.
Running the example
----
```
iojs example.js --source=SOURCE_FILENAME --team=TEAM_ID --ts=TIMESTAMP
```
Where:
- `SOURCE_FILENAME` points to a `.ndjson` file.
- `TEAM_ID` matches one of the teams in your source data
- `TIMESTAMP` is the date in milliseconds (eg. `Date.now()`)
Try it out with the test data:
```
iojs example.js --source=test-entries.ndjson --team=ATeam --ts=1428471302421
```
FAQ
----
### Why don't indexes catchup automatically?
- manual catchup means we can choose to catchup less frequently for more expensive indexes.
- at a later stage we'll add an easy way to opt-in to automatic catchup.
### Why isn't `hoursPerWeek` affecting the timeline?
- it's a field in the doc, so it's considered "timeless".
- if `hoursPerWeek` changes, we consider that a new "contract". Eg. end the old doc and start a new one.