mirror of
https://github.com/documenso/documenso.git
synced 2025-11-10 04:22:32 +10:00
8367878395
## Description <!--- Describe the changes introduced by this pull request. --> <!--- Explain what problem it solves or what feature/fix it adds. --> ## Related Issue <!--- If this pull request is related to a specific issue, reference it here using #issue_number. --> <!--- For example, "Fixes #123" or "Addresses #456". --> ## Changes Made <!--- Provide a summary of the changes made in this pull request. --> <!--- Include any relevant technical details or architecture changes. --> - Change 1 - Change 2 - ... ## Testing Performed <!--- Describe the testing that you have performed to validate these changes. --> <!--- Include information about test cases, testing environments, and results. --> - Tested feature X in scenario Y. - Ran unit tests for component Z. - Tested on browsers A, B, and C. - ... ## Checklist <!--- Please check the boxes that apply to this pull request. --> <!--- You can add or remove items as needed. --> - [ ] I have tested these changes locally and they work as expected. - [ ] I have added/updated tests that prove the effectiveness of these changes. - [ ] I have updated the documentation to reflect these changes, if applicable. - [ ] I have followed the project's coding style guidelines. - [ ] I have addressed the code review feedback from the previous submission, if applicable. ## Additional Notes <!--- Provide any additional context or notes for the reviewers. --> <!--- This might include details about design decisions, potential concerns, or anything else relevant. --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Enhanced project README for clarity and improved environment variables section. - Added comprehensive developer and user documentation, including guides on local development, public API, self-hosting, and compliance standards. - Introduced specific guides for contributing, creating API keys, using webhooks, and setting up security measures. - Detailed documentation on various fields available for document signing to improve user understanding. - Added metadata structuring to improve navigation within the documentation site. - **Chores** - Updated `.gitignore` to better handle project files. - **New Features** - Introduced detailed metadata and documentation for various Documenso functionalities, including signing documents, user profiles, and compliance levels. - Added functionality for Direct Link Signing, enabling easy sharing for document signing. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Timur Ercan <timur.ercan31@gmail.com> Co-authored-by: Lucas Smith <me@lucasjamessmith.me> Co-authored-by: David Nguyen <davidngu28@gmail.com>
64 lines
2.5 KiB
Plaintext
64 lines
2.5 KiB
Plaintext
---
|
|
title: Local Development
|
|
description: Learn how to set up Documenso for local development.
|
|
---
|
|
|
|
# Local development
|
|
|
|
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](/developers/local-development/quickstart)
|
|
- [Manually setting up the development environment](/developers/local-development/manual)
|
|
- [Using Gitpod](/developers/local-development/gitpod)
|
|
|
|
Pick the one that fits your needs the best.
|
|
|
|
## Tech Stack
|
|
|
|
- [Typescript](https://www.typescriptlang.org/) - Language
|
|
- [Next.js](https://nextjs.org/) - Framework
|
|
- [Prisma](https://www.prisma.io/) - ORM
|
|
- [Tailwind](https://tailwindcss.com/) - CSS
|
|
- [shadcn/ui](https://ui.shadcn.com/) - Component Library
|
|
- [NextAuth.js](https://next-auth.js.org/) - Authentication
|
|
- [react-email](https://react.email/) - Email Templates
|
|
- [tRPC](https://trpc.io/) - API
|
|
- [@documenso/pdf-sign](https://www.npmjs.com/package/@documenso/pdf-sign) - PDF Signatures
|
|
- [React-PDF](https://github.com/wojtekmaj/react-pdf) - Viewing PDFs
|
|
- [PDF-Lib](https://github.com/Hopding/pdf-lib) - PDF manipulation
|
|
- [Stripe](https://stripe.com/) - Payments
|
|
- [Vercel](https://vercel.com) - Hosting
|
|
|
|
<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>
|