https://github.com/gsa/sdg-indicators-usa
U.S. National Reporting Platform for the Sustainable Development Goals
https://github.com/gsa/sdg-indicators-usa
Last synced: over 1 year ago
JSON representation
U.S. National Reporting Platform for the Sustainable Development Goals
- Host: GitHub
- URL: https://github.com/gsa/sdg-indicators-usa
- Owner: GSA
- License: mit
- Created: 2016-07-08T21:20:01.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T19:51:32.000Z (over 1 year ago)
- Last Synced: 2024-10-29T22:32:36.152Z (over 1 year ago)
- Language: HTML
- Homepage: https://sdg.data.gov
- Size: 109 MB
- Stars: 34
- Watchers: 30
- Forks: 92
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Open SDG - Site starter
This is a starter repository to help in implementing the [Open SDG](https://github.com/open-sdg/open-sdg) platform. [See here for documentation](https://open-sdg.readthedocs.io).
### Requirements
- [Ruby](https://www.ruby-lang.org/en/) > 3.0
- [Bundler](https://bundler.io/) > 2.0
# Usage
| Command | Description |
|---------|-------------|
| `bundle install` | install the current dependencies |
| `bundle exec jekyll build` | build the site. dumps to `_site` |
| `bundle exec jekyll serve` | builds the site and serves it locally |
### Publication
- the static sites created using this repo are configured to be published by pages.cloud.gov via webhooks. For more information on cloud.gov pages visit the [website](https://cloud.gov/pages/)
### Requirements
- [Ruby](https://www.ruby-lang.org/en/) = 2.6.0
- [Bundler](https://bundler.io/) > 2.0
- [Node](https://nodejs.org/en/download/) > 16.0
NOTE: You must build this repo with Ruby 2.6.0.
### Setup
After you've confirmed the above requirements, all lifecycle operations can be run with NPM scripts (ex. `npm run build`)
| NPM Command | Description |
| ----------- | ------------------------------- |
| build | Build the site |
| setup | Install ruby gems |
| start | Serve a local build |
| test | Check for broken internal links |
| qa | Check for broken external links |
## Contributing
See [CONTRIBUTING](CONTRIBUTING.md) for additional information.
This site is automatically published based on the branch.
## Public domain
This project is in the worldwide [public domain](LICENSE.md). As stated in [CONTRIBUTING](CONTRIBUTING.md):
> 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](https://creativecommons.org/publicdomain/zero/1.0/).
>
> 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.