| 1 | Team directory
|
| 2 | ---
|
| 3 |
|
| 4 | [](https://npmjs.org/package/team-directory) [](https://circleci.com/gh/mapbox/team-directory)
|
| 5 |
|
| 6 | A read/write interface for team data managed on GitHub.
|
| 7 |
|
| 8 | 
|
| 9 |
|
| 10 | ### Features
|
| 11 |
|
| 12 | - List filtering/sorting with stored params
|
| 13 | - [vCard](https://en.wikipedia.org/wiki/VCard) downloads (single or entire team)
|
| 14 | - Stats display based on team data
|
| 15 | - User/admin only editing access
|
| 16 |
|
| 17 | ##### Customization
|
| 18 |
|
| 19 | - Your own data. Provide a json document of form field objects and team
|
| 20 | directory renders each one into submittable fields for each user.
|
| 21 | - Listing display. Limit fields that are displayed on the main listing by opting
|
| 22 | for which ones are used in a template.
|
| 23 | - Stats display
|
| 24 | - Sorting
|
| 25 | - List filtering
|
| 26 | - Form validation
|
| 27 | - Value normalization
|
| 28 |
|
| 29 | ##### Light admin access
|
| 30 |
|
| 31 | If an admin key is set to true on a user they are granted additional features:
|
| 32 |
|
| 33 | - View/edit all users
|
| 34 | - Download all fields from the team list as a CSV document.
|
| 35 |
|
| 36 | ---
|
| 37 |
|
| 38 | ## ☛ [Getting started][]
|
| 39 | ## ☛ [Contributing][]
|
| 40 |
|
| 41 | [Contributing]: https://github.com/mapbox/team-directory/blob/master/CONTRIBUTING.md
|
| 42 | [Getting started]: https://github.com/mapbox/team-directory/blob/master/GETTING_STARTED.md
|
| 43 | [index]: https://github.com/mapbox/team-directory/blob/master/index.html
|