From ca2eb24ffd33678843dd7e1a4cd7ca7a3e687aae Mon Sep 17 00:00:00 2001
From: TITI <162849030+0xtiti@users.noreply.github.com>
Date: Tue, 3 Sep 2024 15:40:46 -0300
Subject: [PATCH] docs: vercel deployment guide (#53)

---
 README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 48 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index ecb0179..7af5105 100644
--- a/README.md
+++ b/README.md
@@ -25,13 +25,15 @@ $ pnpm install
 ## ⚙️ Setting up env variables
 
 - Create `.env` file in the `root` folder and copy paste `.env.example` content in there.
+
 ```
 $ cp .env.example .env
 ```
+
 - Set up `NEXT_PUBLIC_API_BASE_URL` with ZKchainHub Backend API url. It will typically run on `http://localhost:3000`
-- (Optionally) 
-    - Set `NEXT_PUBLIC_PROJECT_ID` with your [Wallet Connect](https://walletconnect.com/) ProjectID
-    - Set `NEXT_PUBLIC_TESTNET_MODE ` with `true` to use testnet mode with testnet backend API URL set up in `NEXT_PUBLIC_API_BASE_URL`
+- (Optionally)
+  - Set `NEXT_PUBLIC_PROJECT_ID` with your [Wallet Connect](https://walletconnect.com/) ProjectID
+  - Set `NEXT_PUBLIC_TESTNET_MODE ` with `true` to use testnet mode with testnet backend API URL set up in `NEXT_PUBLIC_API_BASE_URL`
 
 ## 🏃 Running the app
 
@@ -41,9 +43,51 @@ $ pnpm run start
 
 To verify ZKchainHub UI is running open http://localhost:5173 in your browser
 
+## Deployment
+
+## 🏗️ Vercel deployment
+
+## Prerequisites
+
+1. **Vercel Account**: [Sign up](https://vercel.com) if you don’t have an account.
+2. **Vercel CLI**: Install the Vercel CLI by running:
+
+   ```bash
+   npm install -g vercel
+   ```
+
+## Deployment Steps
+
+1. **Authenticate with Vercel**: Run the following command and follow the prompts to log in
+
+   ```bash
+   vercel login
+   ```
+
+2. **Deploy Your Project**: Navigate to your project directory and run:
+
+   ```bash
+   vercel
+   ```
+
+Follow the prompts to configure your project.
+Vercel will automatically deploy your project and provide a live URL.
+
+3. **Set Environment Variables**: To add environment variables, use:
+
+   ```bash
+   vercel env add <name> <value>
+   ```
+
+**Additional Resources**
+
+- **[Vercel CLI Documentation](https://vercel.com/docs/cli)**: Find comprehensive information on using the Vercel CLI.
+- **[Vercel Documentation](https://vercel.com/docs)**: Access general Vercel documentation and guides.
+
 ## Development
 
 ### 💻 Conventional Commits
+
 We follow the Conventional Commits [specification](https://www.conventionalcommits.org/en/v1.0.0/#specification).
 
 ## Contributing
@@ -52,4 +96,4 @@ ZKchainHub was built with ❤️ by [Wonderland](https://defi.sucks).
 
 Wonderland is a team of top Web3 researchers, developers, and operators who believe that the future needs to be open-source, permissionless, and decentralized.
 
-[DeFi sucks](https://defi.sucks), but Wonderland is here to make it better.
\ No newline at end of file
+[DeFi sucks](https://defi.sucks), but Wonderland is here to make it better.