Node.js server that imports and publishes updates to Team API data.
team-api print-template > path/to/team-api-config.json to generate a
team-api-config.json file. Edit this file to support your installation.
The template is a copy of the
from this repository, which is based on the actual configuration for the 18F
Team API server, and illustrates each of the following settings:
- branch: the repository branch from which to extract update information
- buildPort: the port on which the server will listen for
pushevents to the team-api.18f.gov repo
- updatePort: the port on which the server will listen for updates to
.about.ymlfiles from other 18F repos
- git: path to
giton the host machine
- ruby: path to
rubyon the host machine
- workingDir: path to the 18F/team-api.18f.gov repository clone on the host machine
- updateScript: path to the Ruby script used to process
Install the following if they are not yet present on your system:
- Node.js version 0.12.7 or higher;
- Ruby version 2.2.3 or higher;
- Git version 1.9.1 or higher;
rsync should already be installed on most UNIX-like systems, but the
rsyncOpts configuration option may require adjustment,
particularly on OS X. You may wish to experiment with
rsync manually to
determine which options suit you best.
With the correct Node.js, Ruby, and Git versions in place, run the following:
$ gem install jekyll bundler$ npm install -g team-api-server forever
Finally, as the user on the host that will run the server, generate an SSH key to add to your GitHub account. A new key can be generated by another team member should you leave the organization.
After that, run the following to launch the server via
/usr/local/bin/ are replaced with the appropriate absolute paths:
$ forever start -l /path/to/team-api.log -a /usr/local/bin/team-api /path/to/team-api-config.json
You can find the absolute path to
team-api by running
- Fork the repo (or just clone it if you're an 18F team member)
- Create your feature branch (
git checkout -b my-new-feature)
- Make your changes and test them via
- Lint your changes with
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create a new Pull Request
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.