Generates Sitemap.xml for Code.gov
Code.gov is a website promoting good practices in code development, collaboration, and reuse across the U.S. Government. Code.gov provides tools and guidance to help agencies implement the Federal Source Code Policy. It also includes an inventory of government custom code to promote reuse between agencies and provides tools to help government and the public collaborate on open source projects.
To learn more about the project, check out this blog post.
Code.gov is an open source project, so we invite your contributions, be it in the form of code, design, or ideas.
To run this app locally you'll need a code.gov API key. If you don't have one, go to the following url to obtain one: https://developers.code.gov/key.html
Once you have an API key, clone the repo and run the npm install command in the project's root directory to install all of the project’s dependencies.
Run this terminal command: cp env.example .env
Replace [your api key goes here] in the .env file with your API key
Run the npm run generate terminal command to run the sitemap generation script.
There are more than 6000 projects currently in the project database. The API keys you get from developers.code.gov have a default result limit of 1000 projects. You'll need to get your result limit raised in order to return all projects in the database.
See CONTRIBUTING for additional information.
This project is in the worldwide public domain. As stated in CONTRIBUTING:
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.