Synthra

Synthra is a file hosting application built using FastAPI (with Python >= 3.11) and SvelteKit, with PostgreSQL, SQLAlchemy and Alembic.

This repository contains both the frontend and the backend of the project in their respective folders.

Documentation

This is project meant to enable file-hosting and file sharing, to see a more detailed documentation of the project, please refer to the documentation.

Features

• File hosting
• File previews
• File whitelist
• File expiration
• File quotas
• Roles
• Encryption
• 2FA
• User registration and login
• Intuitive interface
• Support for webhooks
• Account panel
• Administrative panel
• ShareX integration
• Themes

See also FEATURES.md.

Installation

For running the application in production mode, it's highly recommended to use Docker. Otherwise, the manual setup is also available for those who wish to test the application in a development environment.

Quick Deployment

For most users, just these few steps should be sufficient, provided that you are comfortable with using Docker for deploying applications.

1. Grab the docker-compose.prod.yaml file from the repository
2. Rename it to docker-compose.yaml
3. Run docker compose up -d

Development

To setup your environment and the project for development:

1. Run poetry install --no-root (while inside the backend folder)
2. Run pre-commit install

Tests

Tests (Backend)

1. Run cd backend
2. Run poetry run pytest

Tests (Frontend)

1. Run cd frontend
2. Run npm run test

Installation (Docker Setup)

The project contains two Docker Compose configurations. docker-compose.yaml is for the development environment, and docker-compose.prod.yaml is for the production environment.

While building the frontend, the environment variable VITE_BASE_URL should be present, which is the URL to the API. You can also add this to the global .env file.

1. Run git clone git@github.com:Delemangi/synthra.git (or git clone https://github.com/Delemangi/synthra.git)
2. Run docker compose build

Installation (Manual Setup)

The manual setup requires that you have the following requirements installed:

• Python >= v3.11
• Poetry
• Node.js >= v20
• PostgreSQL >= v16

Once you have all these dependencies installed, then:

1. Run git clone git@github.com:Delemangi/synthra.git (or git clone https://github.com/Delemangi/synthra.git)
2. Next, you have to install each module separately.

Backend

1. Navigate to the backend folder: cd backend
2. Run poetry install --no-root

Frontend

1. Navigate to the frontend folder: cd frontend
2. Run npm i
3. Run npm run build

Running

Running (Docker Setup)

1. Copy or rename the .env.sample file to .env, and edit it to your liking, or leave it as is
2. Run docker compose up -d

Running (Manual Setup)

1. Start the PostgreSQL service
2. Apply all migrations: alembic upgrade head
3. Start the backend service
   1. Open the project in your terminal
   2. Run cd backend
   3. Run python -m app.main
4. Start the frontend service
   1. Open the project in your terminal
   2. Run cd frontend
   3. If you would like to start the application in a development environment with hot reloading, then run npm run dev, otherwise npm run preview, provided that you have run npm run build previously

License

This project is licensed under the MIT license.