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>
78 lines
1.9 KiB
Plaintext
78 lines
1.9 KiB
Plaintext
---
|
|
title: Manual Setup
|
|
description: Manually set up Documenso on your machine for local development.
|
|
---
|
|
|
|
import { Callout, Steps } from 'nextra/components';
|
|
|
|
# Manual Setup
|
|
|
|
Follow these steps to set up Documenso on your local machine:
|
|
|
|
<Steps>
|
|
|
|
### Fork Documenso
|
|
|
|
Fork the [Documenso repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) to your GitHub account.
|
|
|
|
### Clone Repository
|
|
|
|
After forking the repository, clone it to your local device by using the following command:
|
|
|
|
```bash
|
|
git clone https://github.com/<your-username>/documenso
|
|
```
|
|
|
|
### Install Dependencies
|
|
|
|
Run `npm i` in the root directory to install the dependencies required for the project.
|
|
|
|
### Set Up Environment Variables
|
|
|
|
Set up the following environment variables in the `.env` file:
|
|
|
|
```bash
|
|
NEXTAUTH_URL
|
|
NEXTAUTH_SECRET
|
|
NEXT_PUBLIC_WEBAPP_URL
|
|
NEXT_PUBLIC_MARKETING_URL
|
|
NEXT_PRIVATE_DATABASE_URL
|
|
NEXT_PRIVATE_DIRECT_DATABASE_URL
|
|
NEXT_PRIVATE_SMTP_FROM_NAME
|
|
NEXT_PRIVATE_SMTP_FROM_ADDRESS
|
|
```
|
|
|
|
Alternatively, you can run `cp .env.example .env` to get started with our handpicked defaults.
|
|
|
|
### Create Database Schema
|
|
|
|
Create the database schema by running the following command:
|
|
|
|
```bash
|
|
npm run prisma:migrate-dev
|
|
```
|
|
|
|
### Optional: Seed the Database
|
|
|
|
Seed the database with test data by running the following command:
|
|
|
|
```bash
|
|
npm run prisma:seed -w @documenso/prisma
|
|
```
|
|
|
|
### Start the Application
|
|
|
|
Run `npm run dev` in the root directory to start the application.
|
|
|
|
### Access the Application
|
|
|
|
Access the Documenso application by visiting `http://localhost:3000` in your web browser.
|
|
|
|
</Steps>
|
|
|
|
<Callout type="info">
|
|
Optional: Create your signing certificate. To generate your own using these steps and a Linux
|
|
Terminal or Windows Subsystem for Linux (WSL), see **[Create your signing
|
|
certificate](/developers/local-development/signing-certificate)**.
|
|
</Callout>
|