Manual Setup
Manually set up Documenso on your machine for local development.
Manual Setup
Follow these steps to set up Documenso on your local machine:
Fork Documenso
Fork the Documenso repository 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>/documensoInstall 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:
NEXTAUTH_SECRET
NEXT_PUBLIC_WEBAPP_URL
NEXT_PRIVATE_DATABASE_URL
NEXT_PRIVATE_DIRECT_DATABASE_URL
NEXT_PRIVATE_SMTP_FROM_NAME
NEXT_PRIVATE_SMTP_FROM_ADDRESSAlternatively, you can run cp .env.example .env to get started with our handpicked defaults.
See the Environment Variables page for more information.
Create database schema
Create the database schema by running the following command:
npm run prisma:migrate-devOptional: seed the database
Seed the database with test data by running the following command:
npm run prisma:seed -w @documenso/prismaStart 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.
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.
See Also
- Developer Quickstart - Quick Docker-based setup
- Signing Certificate - Create a signing certificate