No description
Find a file
2024-11-18 15:00:26 -03:00
docs/source Add top level sequence diagram 2024-11-11 13:24:23 -08:00
packages Move SvelteKit to subfolder 2024-11-18 13:27:35 -03:00
.gitignore Installing SvelteKit 2024-11-12 02:07:39 -03:00
.python-version Initialize project with uv 2024-11-05 11:01:52 -05:00
hello.py Initialize project with uv 2024-11-05 11:01:52 -05:00
pyproject.toml Adding Tahoe-LAFS (conclusion) 2024-11-12 01:09:50 -03:00
README.md Move SvelteKit to subfolder 2024-11-18 13:27:35 -03:00
uv.lock Adding Tahoe-LAFS (conclusion) 2024-11-12 01:09:50 -03:00

Private Facts

Private Facts is a web app to track your private info.

Why private facts?

The project intends to be a demonstration of how to use Tahoe-lafs "provider independent privacy".

Installation

Install from source

git clone https://github.com/blaisep/private_facts.git && cd private_facts

Install from (Docker) Image

TBA

a bash code block

SvelteKit

Requirements

  • NodeJs > 20.0
  • Pnpm

Install dependencies and run:

cd packages
pnpm install
pnpm dev --open

Usage

Run using a (OCI) container

A Python code block

Feedback

The project issue tracker is getting migrated. For now, feel free to open an issue and let us know how how to improve.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Set up the developer environment

Initiate Tahoe-LAFS servers (one introducer, two storage servers and a client server):

Introducer server:

.venv/bin/tahoe create-introducer --listen=tcp --port=5555 --location=tcp:localhost:5555 ./introducer
.venv/bin/tahoe -d introducer run &>/dev/null &

Two storage servers:

.venv/bin/tahoe create-node --introducer $(cat introducer/private/introducer.furl) --nickname storage0 --webport 6001 --location tcp:localhost:6003 --port 6003 ./storage0
.venv/bin/tahoe create-node --introducer $(cat introducer/private/introducer.furl) --nickname storage1 --webport 6101 --location tcp:localhost:6103 --port 6103 ./storage1
.venv/bin/tahoe -d storage0 run &>/dev/null &
.venv/bin/tahoe -d storage1 run &>/dev/null &

Client:

.venv/bin/tahoe create-client --introducer $(cat introducer/private/introducer.furl) --nickname webapp --webport 6401 --shares-total=3 --shares-needed=2 --shares-happy=3 ./webapp
.venv/bin/tahoe -d webapp run &>/dev/null &

The commands should return four PIDs. Note them down to kill them later, when finished, with:

kill -9 <PID>

Getting ready for your first pull request

Please make sure to update tests as appropriate.

We Manage the project with uv, you don't have to.

License

MIT