Skip to content

About

Open-source document approval platform with flexible workflows, email notifications, and a responsive web interface.

Topics

Resources

Stars

16 stars

Watchers

1 watching

Forks

Latest commit

 

History

306 Commits

Folders and files

Repository files navigation

Click2Approve Click2Approve

Get documents approved. Keep everyone on the same page.

Main build status License: MIT

Click2Approve helps you get documents approved and signed. Upload files, choose reviewers, and track decisions in one place.

Open source and free under the MIT License. Host it yourself for personal or business use. Watch a video to see how it works.

Try it locally · Common questions · Documentation · Support the project

Try it locally

You need Docker with Compose and Git. No cloud account, subscription, or external secrets are needed for the local setup.

git clone https://github.com/luarvic/click2approve.git
cd click2approve
docker compose up -d --build

Once the services are ready, open http://localhost:3333/app/ and create an account. Try your first workflow:

  1. Choose New request, enter a title, and upload a document.
  2. Add an approval step using your account's email as the assignee, then submit.
  3. Open Tasks to complete the approval, then Requests to see the outcome.

Next, try multiple reviewers, a required comment, or a signing step with Require an electronic signature enabled. Local email delivery and email confirmation are disabled; in-app notifications work. To try a second participant, create another account in a separate browser profile.

The local landing page and user guides describe the open-source edition in English. The API reference is also included.

Local data is disposable: this demo setup has no persistent data volumes. Running docker compose down removes the database and emulator data with their containers. For production, follow the deployment guide.

Local services, Apple Silicon, and stopping the app

Compose starts the UI, API, event publisher, event consumer, SQL Server, and Azurite (local Blob and Queue Storage). It waits for a successful SQL query, then for the API to initialize the database and respond before starting the workers and UI. Keep both workers running for in-app notifications and queued cleanup. See configuration to enable email or configure your own domain.

On Apple Silicon, enable x86-64 emulation in Docker or Colima for the SQL Server linux/amd64 image.

docker compose ps          # Check service status
docker compose logs -f api # View API logs
docker compose down       # Stop and remove containers

If startup fails, check docker compose ps -a and docker compose logs api. The startup regression check verifies the complete stack against a fresh database without changing your running stack.

This setup uses SQL Server Developer Edition, which is for development and testing. Choose a suitably licensed database for production.

What you can do

When you need to… Click2Approve lets you…
Get the right people involved Build multi-step workflows, with sequential steps and parallel assignees; require everyone or any one assignee to act.
Make the next action clear Request approval, signature, confirmation, acknowledgement, review, verification, acceptance, or completion, with instructions and required comments.
Collect electronic signatures Capture a legal name and drawn signature with IP address and browser evidence; save a reusable signature in your profile.
Give reviewers context Attach multiple documents and preview files while reviewing requests and tasks.
Know where things stand Track incoming tasks, request progress, and decision history; cancel or delete requests.
Keep people informed Send email and in-app notifications with personal notification preferences.
Secure account access Use password or passkey sign-in, authenticator-app MFA, recovery codes, email confirmation, and password reset.
Work from different devices Use the responsive web interface on desktop or mobile, with a first-time guide you can replay from Support.

Common questions

Can I use it in my organization for free?

Yes. The open-source edition is MIT-licensed: you can self-host, use, modify, and integrate it for personal or commercial purposes without a Click2Approve license fee. You cover your own hosting and any database, storage, or email provider costs. See LICENSE and license and trademark for the terms and brand-use guidance.

The free edition supports individual accounts and document workflows with email assignees. Guest approvals through secure email links, organization workspaces, employee roles, teams, workflow templates, discussions, revisions, and verifiable receipts are part of the commercial service. See the hosted edition comparison for the full breakdown.

Can I connect it to my existing systems?

Yes, through the HTTP API and source-level extensions. Explore the Swagger API reference after starting the app to see the available endpoints and authentication flows. You can build adapters for your internal applications or extend the backend's application services.

Integration requires development and authentication; the open-source edition does not include the commercial edition's API-token management. See the architecture guide for extension points.

Am I tied to SQL Server or Azure?

The architecture is designed to make providers replaceable. Workflow rules live in the Domain and Application layers, with persistence, file storage, queues, and email behind interfaces. Provider implementations live in the Infrastructure layer, keeping those choices separate from the workflow logic.

The included setup uses SQL Server / Azure SQL and Azure Blob and Queue Storage; Azurite emulates the storage services locally. To use another RDBMS supported by Entity Framework Core, adapt the EF provider, database mappings, and schema scripts. To use another cloud provider, implement the storage, queue, and email interfaces and update the host registrations and configuration.

These boundaries make it easier to adapt the system to your infrastructure. Alternative providers require code changes and integration testing; they are not bundled configuration switches. See architecture and deployment for the current implementations.

Can I host it on my own infrastructure?

Yes. The UI, API, and background workers run in containers and can be hosted on your own servers or in a cloud environment. The included providers require SQL Server / Azure SQL and Azure Blob and Queue Storage. A fully on-premises installation requires replacing the Azure storage providers, as described above. For production, configure persistent data, backups, HTTPS, secure credentials, and email delivery using the deployment guide.

Want to start right away without setting up infrastructure? Use the hosted Click2Approve service—we handle hosting so you can focus on getting documents approved. The commercial version adds guest approvals through secure email links, organization workspaces, employee roles and teams, reusable workflow templates, discussions, document revisions, verifiable receipts, and API tokens for integrations. Compare editions on the hosted website.

Documentation

Help shape Click2Approve

Would this make your approval process easier? Give the repo a ⭐ using the Star button at the top of this GitHub repository. It helps you find the project again and helps others discover it.

Have a workflow in mind, found a bug, or want to add a provider? Open an issue to share your use case, suggest an improvement, or discuss a contribution.

About

Open-source document approval platform with flexible workflows, email notifications, and a responsive web interface.

Topics

Resources

Stars

16 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages