mirror of
https://github.com/documenso/documenso.git
synced 2026-07-06 02:55:00 +10:00
Lucas Smith
94adea149d
Refresh README/docs for the current stack, add a security policy, note the external-PR pause, and remove dead config and workflows.
68 lines
2.7 KiB
Plaintext
68 lines
2.7 KiB
Plaintext
---
|
|
title: Local Development
|
|
description: Learn how to set up Documenso for local development.
|
|
---
|
|
|
|
## Overview
|
|
|
|
There are multiple ways of setting up Documenso for local development. At the moment of writing this documentation, there are 3 ways of running Documenso locally:
|
|
|
|
- [Using the developer quickstart with Docker](/docs/developers/local-development/quickstart)
|
|
- [Manually setting up the development environment](/docs/developers/local-development/manual)
|
|
- [Using Gitpod](/docs/developers/local-development/gitpod)
|
|
|
|
Pick the one that fits your needs the best.
|
|
|
|
## Tech Stack
|
|
|
|
- [TypeScript](https://www.typescriptlang.org/) - Language
|
|
- [React Router v7](https://reactrouter.com/) - Framework
|
|
- [Hono](https://hono.dev/) - Server
|
|
- [Prisma](https://www.prisma.io/) - ORM
|
|
- [Tailwind CSS](https://tailwindcss.com/) - CSS
|
|
- [shadcn/ui](https://ui.shadcn.com/) + [Radix UI](https://www.radix-ui.com/) - Component Library
|
|
- [react-email](https://react.email/) - Email Templates
|
|
- [Lingui](https://lingui.dev/) - Internationalization
|
|
- [tRPC](https://trpc.io/) - API
|
|
- [@libpdf/core](https://www.npmjs.com/package/@libpdf/core) - PDF Signing and Manipulation
|
|
- [pdf.js](https://mozilla.github.io/pdf.js/) - Viewing PDFs
|
|
- [Stripe](https://stripe.com/) - Payments
|
|
|
|
<div className="mt-16 flex items-center justify-center gap-4">
|
|
<a href="https://documen.so/discord">
|
|
<img
|
|
src="https://img.shields.io/badge/Discord-documen.so/discord-%235865F2"
|
|
alt="Join Documenso on Discord"
|
|
/>
|
|
</a>
|
|
<a href="https://github.com/documenso/documenso/stargazers">
|
|
<img src="https://img.shields.io/github/stars/documenso/documenso" alt="Github Stars" />
|
|
</a>
|
|
<a href="https://github.com/documenso/documenso/blob/main/LICENSE">
|
|
<img src="https://img.shields.io/badge/license-AGPLv3-purple" alt="License" />
|
|
</a>
|
|
<a href="https://github.com/documenso/documenso/pulse">
|
|
<img
|
|
src="https://img.shields.io/github/commit-activity/m/documenso/documenso"
|
|
alt="Commits-per-month"
|
|
/>
|
|
</a>
|
|
<a href="https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/documenso/documenso">
|
|
<img
|
|
alt="open in devcontainer"
|
|
src="https://img.shields.io/static/v1?label=Dev%20Containers&message=Enabled&color=blue&logo=visualstudiocode"
|
|
/>
|
|
</a>
|
|
<a href="https://github.com/documenso/documenso/blob/main/CODE_OF_CONDUCT.md">
|
|
<img
|
|
src="https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg"
|
|
alt="Contributor Covenant"
|
|
/>
|
|
</a>
|
|
</div>
|
|
|
|
## See Also
|
|
|
|
- [Contributing](/docs/developers/contributing) - Learn how to contribute to Documenso
|
|
- [Self-Hosting](/docs/self-hosting) - Deploy your own instance
|