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

Update README.md #7

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
61 changes: 53 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,68 @@
# To Get Started
```markdown
# Commons Claimer Frontend

## Frontend
This repository hosts the frontend for the **Commons Protocol Claimer**. Follow the steps below to set up, develop, and build the project.

### setup frontend
---

```
## Prerequisites

Before starting, ensure you have the following installed:
- [Node.js](https://nodejs.org/) (version >= 16)
- [pnpm](https://pnpm.io/) (preferred package manager)
- A `.env.local` configuration file (see [Environment Variables](#environment-variables)).

pnpm install && cp .env.example .env.local
---

## Getting Started

### 1. Clone the Repository
```bash
git clone https://github.com/yourusername/commons-claimer-frontend.git
cd commons-claimer-frontend
```

### run local
### 2. Install Dependencies
Use `pnpm` to install all required dependencies:
```bash
pnpm install
```

### 3. Set Up Environment Variables
Copy the example environment file and configure it:
```bash
cp .env.example .env.local
```
Customize `.env.local` with your specific settings.

---

## Development

### Run Locally
Start the development server:
```bash
pnpm dev
```
Visit the application at [http://localhost:3000](http://localhost:3000).

### build
---

```
## Build for Production

To build the application for deployment:
```bash
pnpm build
```
The production-ready files will be in the `dist` folder.

---

## Environment Variables

| Variable | Description | Default Value |
|-------------------|---------------------------------|-------------------------|
| `API_URL` | Base URL for the backend API | `http://localhost:4000` |
| `NEXT_PUBLIC_ENV` | Current environment (dev/prod) | `development` |

---