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

fixed typo

flō
2023-09-08 09:56:13 +02:00
parent e2f1c0d88a
commit c1d0175ccb
1 changed files with 22 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
Deploying-Documenso-with-Supabase-and-Vercel.md

@ -1,14 +1,14 @@
> by [@dephraiim](https://github.com/dephraiim)
In this article, we’ll walk you through how to deploy and self-host Documenso using Vercel, Supabase, and Resend.
In this article, we'll walk you through how to deploy and self-host Documenso using Vercel, Supabase, and Resend.
You’ll learn:
You'll learn:
- How to set up a Postgres database using Supabase,
- How to install SMTP with Resend,
- How to deploy your project with Vercel.
If you don’t know what [Documenso](https://documenso.com/) is, it’s an open-source alternative to DocuSign, with the mission to create an open signing infrastructure while embracing openness, cooperation, and transparency.
If you don't know what [Documenso](https://documenso.com/) is, it's an open-source alternative to DocuSign, with the mission to create an open signing infrastructure while embracing openness, cooperation, and transparency.
## Prerequisites
@ -25,7 +25,7 @@ Checklist:
## Step-by-Step guide to deploying Documenso with Supabase, Resend, and Vercel
To deploy Documenso, we’ll take the following steps:
To deploy Documenso, we'll take the following steps:
1. Fork the Documenso repository
2. Clone the forked repository and install dependencies
@ -37,15 +37,15 @@ To deploy Documenso, we’ll take the following steps:
8. Create a new project on Vercel
9. Add Environment Variables to your Vercel project
So, you’re ready? Let’s dive in!
So, you're ready? Let's dive in!
### Step 1: Fork the Documenso repository
Start by creating a fork of Documenso on GitHub. You can do this by visiting the [Documenso repository](https://github.com/documenso/documenso) and clicking on the 'Fork' button. (Also, star the repo!)
![](https://prod-files-secure.s3.us-west-2.amazonaws.com/be04d083-a663-4e01-b888-b0c4cedd4d69/48cd4db4-0682-4416-acdc-7b3d9eb0c7cd/CleanShot_2023-09-05_at_16.01.542x.png)
Choose your GitHub profile as the owner and click on ‘Create fork’ to create a fork of the repo.
Choose your GitHub profile as the owner and click on 'Create fork' to create a fork of the repo.
![](https://prod-files-secure.s3.us-west-2.amazonaws.com/be04d083-a663-4e01-b888-b0c4cedd4d69/91781a68-119c-41cc-97f9-6ee24aa5838e/Untitled.png)
@ -61,7 +61,7 @@ gh repo clone [your_github_username]/documenso
git clone <https://github.com/[your_github_username]/documenso.git>
```
You can now navigate into the directory and install the project’s dependencies:
You can now navigate into the directory and install the project's dependencies:
```bash
cd documenso
@ -70,21 +70,21 @@ npm install
### Step 3: Create a new project on Supabase
Now, let’s set up the database.
Now, let's set up the database.
If you haven't already, create a new project on Supabase. This will automatically create a new Postgres database for you.
On your Supabase dashboard, click the ‘**New project’** button and choose your organization.
On your Supabase dashboard, click the '**New project**' button and choose your organization.
On the ‘**Create a new project’** page, set a database name of **documenso** and a secure password for your database. Choose a region closer to you, a pricing plan, and click on ‘**Create new project’** to create your project.
On the '**Create a new project**' page, set a database name of **documenso** and a secure password for your database. Choose a region closer to you, a pricing plan, and click on '**Create new project**' to create your project.
![](https://s3-us-west-2.amazonaws.com/secure.notion-static.com/3e68a3ad-a4e2-4a70-9ba8-c756190d796e/CleanShot_2023-08-28_at_19.56.162x.png)
### Step 4: Copy the Supabase Postgres database connection URL
In your project, click the ‘**Settings**’ icon at the bottom left.
In your project, click the '**Settings**' icon at the bottom left.
Under the ‘**Project Settings’** section, click ‘**Database**’ and scroll down to the ‘**Connection string**’ section. Copy the ‘**URI**’ and update it with the password you chose in the previous step.
Under the '**Project Settings**' section, click '**Database**' and scroll down to the '**Connection string**' section. Copy the '**URI**' and update it with the password you chose in the previous step.
![](https://s3-us-west-2.amazonaws.com/secure.notion-static.com/13e5f295-5dc6-4f8b-ab69-40bac7bfd60e/CleanShot_2023-08-28_at_20.08.142x.png)
@ -110,7 +110,7 @@ npx prisma migrate deploy
### Step 7: Get your SMTP Keys on Resend
So, you’ve just cloned Documenso, installed dependencies on your local machine, and set your database using Supabase. Now, SMTP is missing. Emails won’t go out! Let’s fix it with Resend.
So, you've just cloned Documenso, installed dependencies on your local machine, and set your database using Supabase. Now, SMTP is missing. Emails won't go out! Let's fix it with Resend.
In the **[Resend](https://resend.com/)** dashboard, click 'Add API Key' to create a key for Resend SMTP.
@ -132,9 +132,9 @@ MAIL_FROM='noreply@[YOUR_DOMAIN]'
### Step 8: Create a new project on Vercel
You set the database with Supabase and are SMTP-ready with Resend. Almost there! The next step is to deploy the project — we’ll use Vercel for that.
You set the database with Supabase and are SMTP-ready with Resend. Almost there! The next step is to deploy the project — we'll use Vercel for that.
On your Vercel dashboard, create a new project using the forked project from your GitHub repositories. Select the project among the options and click ‘**Import**’ to start running Documenso.
On your Vercel dashboard, create a new project using the forked project from your GitHub repositories. Select the project among the options and click '**Import**' to start running Documenso.
![](https://s3-us-west-2.amazonaws.com/secure.notion-static.com/d134f915-e933-451a-93cd-37301e393456/CleanShot_2023-08-28_at_20.49.032x.png)
@ -148,7 +148,9 @@ For example, in my case, the deployment URL is `https://documenso-supabase-web.v
![](https://s3-us-west-2.amazonaws.com/secure.notion-static.com/d7097a19-22d1-453d-9b1e-aea7a7c7c182/CleanShot_2023-08-28_at_21.10.152x.png)
This is a sample `.env` to deploy. Copy and paste it to auto-populate the fields and click ‘**Deploy.’** Now, you only need to wait for your project to deploy. You’re going live — enjoy!
This is a sample `.env` to deploy. Copy and paste it to auto-populate the fields and click '**Deploy**'. Now, you only need to wait for your project to deploy.
You're going live — enjoy!
```bash
DATABASE_URL='postgresql://postgres:typeinastrongpassword@db.njuigobjlbteahssqbtw.supabase.co:5432/postgres'
@ -174,7 +176,7 @@ NEXT_PUBLIC_ALLOW_SIGNUP=true
![](https://s3-us-west-2.amazonaws.com/secure.notion-static.com/840be944-7c88-44f2-ac5d-0263e91261eb/CleanShot_2023-08-28_at_21.26.562x.png)
Congratulations! 🎉 You’ve successfully deployed Documenso using Vercel, Supabase, and Resend. You’re now ready to create and sign your own documents with your self-hosted Documenso!
Congratulations! 🎉 You've successfully deployed Documenso using Vercel, Supabase, and Resend. You're now ready to create and sign your own documents with your self-hosted Documenso!
In this step-by-step guide, you learned how to:
@ -182,6 +184,6 @@ In this step-by-step guide, you learned how to:
- install SMTP with Resend,
- deploy your project with Vercel.
Over to you! How was the tutorial? If you enjoyed it, please do share! And if you have any questions or comments, please reach to me on [Twitter / X](https://twitter.com/EphraimDuncan_) (DM open) or [Discord](https://documen.so/discord).
Over to you! How was the tutorial? If you enjoyed it, please do share! And if you have any questions or comments, please reach out to me on [Twitter / X](https://twitter.com/EphraimDuncan_) (DM open) or [Discord](https://documen.so/discord).
We’re building an open-source alternative to DocuSign and welcome every contribution. Head over to the GitHub repository and [leave us a Star](https://github.com/documenso/documenso)!
We're building an open-source alternative to DocuSign and welcome every contribution. Head over to the GitHub repository and [leave us a Star](https://github.com/documenso/documenso)!