Developer Quickstart
Note: This guide assumes that you have both docker (opens in a new tab) and docker-compose (opens in a new tab) installed on your machine.
Want to get up and running quickly? Follow these steps:
Fork Documenso
Fork the Documenso repository (opens in a new tab) to your GitHub account.
Clone Repository
After forking the repository, clone it to your local device by using the following command:
git clone https://github.com/<your-username>/documensoSet Up Environment Variables
Set up your environment variables in the .env file using the .env.example file as a reference.
Alternatively, you can run cp .env.example .env to get started with our handpicked defaults.
Start Database and Mail Server
Run npm run dx in the root directory.
This will spin up a Postgres database and inbucket mailserver in a docker container.
Start the Application
Run npm run dev in the root directory to start the application.
(Optional) Fasten the Process
Want it even faster? Just use:
npm run dAccess Points for the Project
You can access the following services:
- Main application - http://localhost:3000 (opens in a new tab)
- Incoming Mail Access - http://localhost:9000 (opens in a new tab)
- Database Connection Details:
- Port: 54320
- Connection: Use your favourite database client to connect to the database.
- S3 Storage Dashboard - http://localhost:9001 (opens in a new tab)