Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stophecom/sharrr-svelte
End-to-end encrypted file transfer.
https://github.com/stophecom/sharrr-svelte
cryptography e2ee file-transfer file-upload svelte tailwindcss web webcrypto
Last synced: 1 day ago
JSON representation
End-to-end encrypted file transfer.
- Host: GitHub
- URL: https://github.com/stophecom/sharrr-svelte
- Owner: stophecom
- License: mit
- Created: 2023-01-18T19:32:31.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T18:35:51.000Z (17 days ago)
- Last Synced: 2024-10-24T21:33:02.070Z (17 days ago)
- Topics: cryptography, e2ee, file-transfer, file-upload, svelte, tailwindcss, web, webcrypto
- Language: Svelte
- Homepage: https://www.sharrr.com
- Size: 2.86 MB
- Stars: 120
- Watchers: 3
- Forks: 4
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# sharrr
**One-time end-to-end encrypted file transfer.**
Transfer files (of virtually unlimited size) asynchronously and in the most secure way possible.
Learn more about the [technical implementation](https://sharrr.com/about). See how [sharrr compares](https://github.com/stophecom/sharrr-svelte/blob/main/src/routes/about/comparison.md) to other services.
Website: [www.sharrr.com](https://sharrr.com)
Help keep this project running: [Make a donation](https://donate.stripe.com/28oeV1gKP3bv4b6144)
## Developing
Before you start, add an `.env` file at the root of the project. See below.
```bash
# Initial installation
pnpm i
# Run dev server
pnpm run dev
# or start the server and open the app in a new browser tab
pnpm run dev -- --open
```
### DB
#### Prisma ORM
```bash
# Init primsa
npx prisma init
# Push schema to Postgres
npx prisma db push
# Open prisma studio locally
npx prisma studio
# After changes in DB are made. Should not be necessary.
# https://www.prisma.io/docs/concepts/components/prisma-client#4-evolving-your-application
npx prisma generate
```
#### Postgres Database
Using Vercel Postgres Database currently, but can be done with any Prisma compatible database.
### Tests
```bash
# Run unit tests with vitest
# Important: Node 19+ is required (Support for crypto modules)
pnpm run test:unit
# E2E tests with playwright
pnpm run test
```
### Building
To create a production version of your app:
```bash
pnpm run build
```
You can preview the production build with `pnpm run preview`.
### Maintenance
There is a Github workflow `cron-cleanup-files.yml` that runs every day to cleanup old files.
See `src/routes/api/v1/cron/+server.ts` for more info.
You can trigger the cron job locally with:
```bash
curl --request POST \
--url 'http://localhost:3000/api/v1/cron' \
--header 'Authorization: Bearer API_SECRET_KEY'
```
## Self hosting
> **Note**
> The project currently runs un Vercel, uses S3 for storage and Vercel Postgres DB. Self-hosting requires you to replace those 3rd party solutions.
### Current setup
#### ENV Variables
```bash
# Postgres
POSTGRES_PRISMA_URL='postgres://'
POSTGRES_URL_NON_POOLING='postgres://' # Direct Connection
# S3 compatible object storage e.g. AWS
S3_ENDPOINT=''
S3_ACCESS_KEY=''
S3_SECRET_KEY=''
PUBLIC_S3_BUCKET=''
# Vercel specific, but can be easily replaced.
VERCEL_URL='http://localhost:3000'
PUBLIC_ENV='development' # preview/production
# Only used for cron jobs that run using Github Actions.
API_SECRET_KEY=''
```
### With Docker (WIP)
You'll need to edit the environment variables within the `.env` file.
> **Note**
> To run the app in Docker you still need to connect your own DB. Same goes if you want to run your own S3 storage solution. This part is not covered yet.
Once you've done that, you can do the following:
```bash
# to start the docker container
sudo docker compose up -d
# to stop the docker container
sudo docker compose down
# to check logs
sudo docker logs sharrr
```
## About
About the author: [stophe.com](https://stophe.com)
### Stack
- SvelteKit
- Tailwind CSS
- PostgreSQL (Database)
- Prisma (ORM)
- Doppler (For env handling)
This project is tested with BrowserStack.
### Infrastructure
- Website and Postgres on [Vercel](https://vercel.com/)
- S3 Object Storage with [flow.swiss](https://flow.swiss)
### License
[MIT](https://opensource.org/license/mit/) (Code)
[CC BY-NC-ND](https://creativecommons.org/licenses/by-nc-nd/4.0/) (Creatives)