Developer Guide¶

Thanks for your interest in contributing to Quicksend! Contributations are always welcome.

For significant changes or new features, please open an issue first. This helps us settle on the approach and ensures your work fits the project's goals.

Prerequisites¶

To get started, make sure you have the following installed:

.NET Core 10 (for API development)
Node 25 (for frontend development)

Getting Started¶

First, fork the repository, then clone your fork locally:

git clone https://codeberg.org/YOUR_USERNAME/quicksend

Keep changes in feature branches

We recommend creating a dedicated branch for every bugfix or feature. This keeps your Pull Requests (PRs) clean and allows us to review multiple contributions independently.

Development Environment¶

Quicksend requires both the backend and frontend services to be running simultaneously.

Running the API¶

Navigate to source/api/Quicksend.Api. You can launch the service using your IDE with "Development" profile or via the CLI:

dotnet run --launch-profile "Development"

Running the Frontend¶

Navigate to source/frontend and initialize the environment:

# Install dependencies
npm install

# Start the development server
npm run dev