Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dsacms/iv-delivery
https://github.com/dsacms/iv-delivery
Last synced: about 6 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/dsacms/iv-delivery
- Owner: DSACMS
- License: cc0-1.0
- Created: 2024-06-23T17:39:33.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-06-25T14:22:17.000Z (5 months ago)
- Last Synced: 2024-06-25T15:55:38.661Z (5 months ago)
- Language: Java
- Size: 21.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS.md
- Security: SECURITY.md
- Governance: GOVERNANCE.md
Awesome Lists containing this project
README
# Income Verification Document Delivery Service
## About the Project
Document Delivery transports a file to a destination location as determined by the caller. This service is created for investigation and evaluation purposes only.
## Core Team
An up-to-date list of core team members can be found in [MAINTAINERS.md](MAINTAINERS.md).
# Development and Software Delivery Lifecycle
The following guide is for members of the project team who have access to the repository as well as code contributors. The main difference between internal and external contributions is that external contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contributing, see: [CONTRIBUTING.md](./CONTRIBUTING.md).
## Local Development
### System Requirements
* Java 17+
* Maven 3.9.7+
### Installing
```shell
git clone [email protected]:dsacms/iv-delivery.git
cd iv-delivery
```
### Building
```shell
mvn install
```
### Running
```shell
mvn spring-boot:run
```
To ping, go to http://localhost:8080/deliver/ping or in a terminal:
```shell
curl http://localhost:8080/delivery/ping
```
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for information about our contribution guidelines.
## Codeowners
See [CODEOWNERS.md](CODEOWNERS.md) for information on those responsible for the code and documentation in this repository.
## Community
The Income Verification Document Delivery Service team is taking a community-first and open source approach to the product development of this tool. We believe government software should be made in the open and be built and licensed such that anyone can download the code, run it themselves without paying money to third parties or using proprietary software, and use it as they will.
We know that we can learn from a wide variety of communities, including those who will use or will be impacted by the tool, who are experts in technology, or who have experience with similar technologies deployed in other spaces. We are dedicated to creating forums for continuous conversation and feedback to help shape the design and development of the tool.
We also recognize capacity building as a key part of involving a diverse open source community. We are doing our best to use accessible language, provide technical and process documents, and offer support to community members with a wide variety of backgrounds and skillsets.
### Community Guidelines
Principles and guidelines for participating in our open source community are can be found in [COMMUNITY_GUIDELINES.md](COMMUNITY_GUIDELINES.md). Please read them before joining or starting a conversation in this repo or one of the channels listed below. All community members and participants are expected to adhere to the community guidelines and code of conduct when participating in community spaces including: code repositories, communication channels and venues, and events.
## Policies
### Open Source Policy
We adhere to the [CMS Open Source
Policy](https://github.com/CMSGov/cms-open-source-policy). If you have any
questions, just [shoot us an email](mailto:[email protected]).
### Security and Responsible Disclosure Policy
*Submit a vulnerability:* Unfortunately, we cannot accept secure submissions via
email or via GitHub Issues. Please use our website to submit vulnerabilities at
[https://hhs.responsibledisclosure.com](https://hhs.responsibledisclosure.com).
HHS maintains an acknowledgements page to recognize your efforts on behalf of
the American public, but you are also welcome to submit anonymously.
For more information about our Security, Vulnerability, and Responsible Disclosure Policies, see [SECURITY.md](SECURITY.md).
## Public domain
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/) as indicated in [LICENSE](LICENSE).
All contributions to this project will be released under the CC0 dedication. By submitting a pull request or issue, you are agreeing to comply with this waiver of copyright interest.