Developer Quickstart

Want to get up and running quickly? Follow these steps:

1

Fork Documenso
2

Fork the Documenso repository to your GitHub account.
3

Clone Repository
4

After forking the repository, clone it to your local device by using the following command:
5

git clone https://github.com/<your-username>/documenso
6

Set Up Environment Variables
7

Set up your environment variables in the .env file using the .env.example file as a reference.
8

Alternatively, you can run cp .env.example .env to get started with our handpicked defaults.
9

Start Database and Mail Server
10

Run npm run dx in the root directory.
11

This will spin up a Postgres database and inbucket mailserver in a docker container.
12

Start the Application
13

Run npm run dev in the root directory to start the application.
14

(Optional) Fasten the Process
15

Want it even faster? Just use:
16

npm run d

Access Points for the Project

You can access the following services: