Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: vercel deployment guide #53

Merged
merged 2 commits into from
Sep 3, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 48 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand All @@ -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.
[DeFi sucks](https://defi.sucks), but Wonderland is here to make it better.
Loading