PyNeutrino

📮 Send your secrets securely to third-parties, using client-to-client encryption.

This project has many of its features inspired from Datash and PasswordPusher.

❯ Install

TODO (once a docker package has been made)

❯ Contributing

❯ Development setup

At first, you should start the database:

docker compose up -d

You can initialize and start the backend with:

poetry install
poetry run alembic upgrade head
poetry run gunicorn

If you want to override the configuration of the backend environment, you can follow these steps:

touch local_config.yaml
# Set values in local_config.yaml
poetry run gunicorn --env "NEUTRINO_SETTING_FILE=$(pwd)/local_config.yaml"

Once started, you can set up and start the frontend web server:

cd frontend-src
npm install
npm run serve

The application is then available on http://localhost:4200

If you want to work on the french translation, start the frontend dev server with npm run serve-fr instead.

Important caveats:

• This project does not use the Flask-SQLAlchemy extension. Do not go to their documentation for insights, but SQLAlchemy's instead.

Tests

To run the tests, you can execute the following commands:

poetry run tox run

❯ Notice

Some content from open-source libraries was used as sources:

• Twemoji (CC-BY 4.0 Licence)