Ryan/documenso
1
0
Fork 1
mirror of https://github.com/documenso/documenso.git synced 2025-11-14 08:42:12 +10:00
Code Issues Packages Projects Releases Wiki Activity

chore: lots of content updates

Browse Source
This commit is contained in:
Catalin Pit
2024-04-26 15:35:53 +03:00
parent 885809603a
commit 1387ce11f9
6 changed files with 177 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
apps/documentation/pages/local-development/quickstart.mdx
View File

@ -3,41 +3,64 @@ title: Developer Quickstart
description: Quickly set up Documenso on your machine for local development with Docker and Docker Compose.
---
import { Callout, Steps } from 'nextra/components';
# Developer Quickstart
> **Note**: This is a quickstart for developers. It assumes that you have both [docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/) installed on your machine.
<Callout type="info">
**Note**: This guide assumes that you have both [docker](https://docs.docker.com/get-docker/) and
[docker-compose](https://docs.docker.com/compose/) installed on your machine.
</Callout>
Want to get up and running quickly? Follow these steps:
1. [Fork this repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) to your GitHub account.
<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:
```sh
```bash
git clone https://github.com/<your-username>/documenso
```
2. Set up your `.env` file using the recommendations in the `.env.example` file. Alternatively, just run `cp .env.example .env` to get started with our handpicked defaults.
### Set Up Environment Variables
3. Run `npm run dx` in the root directory
Set up your environment variables in the `.env` file using the `.env.example` file as a reference.
- This will spin up a postgres database and inbucket mailserver in a docker container.
Alternatively, you can run `cp .env.example .env` to get started with our handpicked defaults.
4. Run `npm run dev` in the root directory
### Start Database and Mail Server
5. Want it even faster? Just use
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:
```sh
npm run d
```
#### Access Points for Your Application
</Steps>
1. **App** - http://localhost:3000
2. **Incoming Mail Access** - http://localhost:9000
3. **Database Connection Details**
### Access Points for the Project
- **Port**: 54320
- **Connection**: Use your favorite database client to connect using the provided port.
You can access the following services:
4. **S3 Storage Dashboard** - http://localhost:9001
- Main application - http://localhost:3000
- Incoming Mail Access - http://localhost:9000
- Database Connection Details:
- Port: 54320
- Connection: Use your favourite database client to connect to the database.
- S3 Storage Dashboard - http://localhost:9001