Merge remote-tracking branch 'origin/main'
This commit is contained in:
commit
0ed8d2e876
3 changed files with 72 additions and 2540 deletions
2541
.gitignore
vendored
2541
.gitignore
vendored
File diff suppressed because one or more lines are too long
64
README.md
64
README.md
|
@ -0,0 +1,64 @@
|
||||||
|
# Private Facts
|
||||||
|
|
||||||
|
Private Facts is a web app to track your private info.
|
||||||
|
|
||||||
|
[//]: # (Tahoe Logo)
|
||||||
|
|
||||||
|
|
||||||
|
[//]: # (Badges: Build status, UV, Python version, Downloads)
|
||||||
|
|
||||||
|
|
||||||
|
#### Why private facts?
|
||||||
|
|
||||||
|
The project intends to be a demonstration of how to use [Tahoe-lafs]() "provider independent privacy".
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
#### Install from source
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/blaisep/private_facts.git && cd private_facts
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Install from (Docker) Image
|
||||||
|
|
||||||
|
TBA
|
||||||
|
|
||||||
|
####
|
||||||
|
|
||||||
|
```bash
|
||||||
|
a bash code block
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Run using a (OCI) container
|
||||||
|
|
||||||
|
|
||||||
|
```python
|
||||||
|
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
|
||||||
|
|
||||||
|
### Getting ready for your first pull request
|
||||||
|
|
||||||
|
Please make sure to update tests as appropriate.
|
||||||
|
|
||||||
|
We Manage the project with [uv](https://docs.astral.sh/uv/), you don't have to.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
[MIT](https://choosealicense.com/licenses/mit/)
|
||||||
|
|
||||||
|
[//]: # ( This file was inspired by https://www.makeareadme.com/ )
|
7
uv.lock
generated
Normal file
7
uv.lock
generated
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
version = 1
|
||||||
|
requires-python = ">=3.11"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "private-facts"
|
||||||
|
version = "0.1.0"
|
||||||
|
source = { virtual = "." }
|
Loading…
Add table
Add a link
Reference in a new issue