https://github.com/freedomofpress/securedrop-dev-docs

SecureDrop Developer Documentation
https://github.com/freedomofpress/securedrop-dev-docs

Last synced: 7 days ago
JSON representation

SecureDrop Developer Documentation

• Host: GitHub
• URL: https://github.com/freedomofpress/securedrop-dev-docs
• Owner: freedomofpress
• License: other
• Created: 2022-08-25T22:00:02.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-30T20:04:57.000Z (14 days ago)
• Last Synced: 2024-10-30T21:18:03.191Z (14 days ago)
• Language: Shell
• Homepage:
• Size: 38.5 MB
• Stars: 4
• Watchers: 7
• Forks: 3
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Support: docs/supported_languages.rst

Awesome Lists containing this project

README

        
> By contributing to this project, you agree to abide by our [Code of Conduct](https://github.com/freedomofpress/.github/blob/main/CODE_OF_CONDUCT.md).

SecureDrop is an open-source whistleblower submission system that media organizations can use to securely accept documents from, and communicate with anonymous sources. It was originally created by the late Aaron Swartz and is currently managed by the [Freedom of the Press Foundation](https://freedom.press).

This repository is used to build the [developer documentation](https://developers.securedrop.org/) for SecureDrop. Documentation for SecureDrop end users (sources, journalist and administrators) is available at https://docs.securedrop.org/ and built from https://github.com/freedomofpress/securedrop-docs.

## Quickstart

1. [Install poetry](https://python-poetry.org/docs/#installation)

2. Install the project requirements using `poetry install`

3. Run `make docs` to start a live build of the documentation at http://localhost:8000

4. Edit RST files under the docs directory - your changes will be reflected in the live build

## License

SecureDrop is open source and released under the [GNU Affero General Public License v3](/LICENSE).