The United States Kimberley Process Authority (USKPA) is a not-for-profit trade association in the United States formed for the purpose of administering and controlling the usage of U.S. Kimberley Process (KP) certificates for the export of rough diamonds from the U.S.
The USKPA is governed by a Board of Directors and is located in New York City.
This repository hosts the code that powers the uskpa.org website. A key component of the site is a system that administers the usage of KP certificates.
There are limited developer resources on this project; for both development and maintenance. Thus the aim is to minimize custom code by leveraging as many open source frameworks (i.e. reuse) and their associated default services.
The project intentionally uses open source frameworks which allows USKPA.org to engage community at large of skilled developers that can contribute to feature enhancements and bug fixes going forward.
The frameworks this site uses are:
- Django web framework to enable rapid development. It includes an admin panel for user, group management.
- U.S. Web Design System that follows design principles that create better experiences for USKPA.org's users.
- PostgreSQL database.
The development and production instances of the uskpa.org are hosted on the cloud platform, Heroku. Deployment pipelines (using CircleCI) and processes are documented here. The deployment pipelines includes automatically running the following checks to preserve quality:
- Static code analysis using Flake8
- Vulnerability scans using Snyk
- Regression test suite
- Test code coverage using Codecov
In addition to Heroku's monitoring, USKPA.org also uses New Relic monitoring to keep administrators appraised of any operational issues with the site.
Documentation is located wthin in the docs directory. This documentation includes developer and site administration documentation. As code changes are introduced, this documentation should be kept up to date to facilitate engagement by future contributors.
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.