Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 2.48 KB

contributing.md

File metadata and controls

33 lines (21 loc) · 2.48 KB

NYCO User Interface (UI) Patterns Framework

This site is built with the NYCO Patterns CLI and styled using the NYCO Patterns. The Tonic Component Framework renders the list of repositories using meta data retrieved from the GitHub REST API.

Contributing

Clone the repository and run npm install. You will need a GitHub Personal Access Token to be able to get up-to-date repository data. Generate a token in your developer settings, add it as the contents of the .gh-token.sample file and rename the file to .gh-token.

Commands

Commands are stored in the package.json file and can be run using NPM. Commands follow this pattern.

npm run {{ command }}

Below is a description of the available commands.

Command Arguments Description
start Runs the Pattern CLI development server with watching and reloading.
default Runs the default Pattern CLI build command.
version major/minor/patch Hooks into the npm version script by regenerating the build with the version number.
ghpages Run the default command and publish to the testing environment.
meta Regenerate the dist/data/repositories.json file. This command requires a Personal GitHub Access Token you can generate in your developer settings.

Additional commands from the Patterns CLI can also be run. Most commands will require the NODE_ENV variable to be set.


The Mayor's Office for Economic Opportunity

The Mayor's Office for Economic Opportunity (NYC Opportunity) is committed to sharing open-source software that we use in our products. Feel free to ask questions and share feedback. Interested in contributing? See our open positions on buildwithnyc.github.io. Follow our team on Github (if you are part of the @cityofnewyork organization) or browse our work on Github.