- a web app that helps you share files safely. You can send any kind of file, like documents, photos, or videos;
- makes sure only the people you want can see your files (groups);
- easy to use and cares about your privacy.
Share more, worry less.
SHARESAFE
├── backend # Server related files
│ ├── files # Encrypted files
| ├── prisma # Database "schema" and migrations
| ├── src # Source code
| ├── ├── modules # Modules
| ├── ├── utils # Utility functions (e.g. password hashing)
| |── ├── tests # Server tests - using Tap
| |── ├── ... # Other essential files (e.g. server)
├── frontend # Client related files
│ ├── sharesafe-docs # Documentation files
│ ├── src # Source code for the app
│ ├── ├── auth # Authentication related files
│ ├── ├── components # React components
| ├── ├── encryption # Encryption related files
| ├── ├── subPages # Subpages
| ├── ├── test # Client tests - using Vitest
| ├── ├── ... # Other essential files (e.g. App.tsx)
- Node.js version 16.14 or above:
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
Go to your desired folder in your computer and clone the repo using:
git clone https://github.com/carvalho28/SHARESAFE
You need to have a database ready o use, inside /backend
, create a .env
with:
DATABASE_URL="database_url"
And then, to set it up using prisma, just run, on the global folder:
cd backend && npx prisma migrate dev --name init
After this, you have set up your database.
After cloning the repo, navigate to the created folder using:
cd SHARESAFE
Then install all the necessary dependencies using:
yarn install:deps
To run the development server after installing the dependencies, use:
yarn dev
The development server of the app will be running at http://localhost:5173/.
The development server of the docs will be running at http://localhost:5174/.