> For the complete documentation index, see [llms.txt](https://coat.gitbook.io/paal-ai-apis/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://coat.gitbook.io/paal-ai-apis/paal-ecosystem-frontend-setup.md).

# Paal Ecosystem Frontend Setup

This pages discuss on how to setup the Paal eco system frontend

***

## Paal Frontend Documentation

### Overview

The Paal Frontend is the user interface component of the Paal ecosystem platform, providing users with access to various features and functionalities of the platform.

### Table of Contents

1. Introduction
2. Configuration Setup
3. Package.json Configuration
4. Running the Frontend
5. Conclusion

### Introduction

The Paal Frontend serves as the user interface for the Paal ecosystem platform. This documentation provides detailed instructions on setting up and configuring the frontend to ensure it runs smoothly.

### Configuration Setup

Before setting up the Paal Frontend, ensure the following configuration is adjusted:

#### Config.tsx File

Set the backend API URL in the `config.tsx` file:

```typescript
const BACKEND_API = "<BACKEND_API_URL>";
```

Ensure the URL points to the correct backend endpoint.

#### Package Installation

This is a Node.js application, so install the necessary packages using npm:

```bash
npm install
```

### Running the Frontend

To start the Paal Frontend, use the following commands:

#### Development Mode

For development mode, run:

```bash
npm run dev
```

This will start the development server and open the application in your default browser.

#### Build

To build the project for production, run:

```bash
npm run build
```

This will compile the TypeScript code and bundle the application for deployment.

#### Lint

To lint the code, run:

```bash
npm run lint
```

This will run ESLint to check for code quality and style issues.

#### Preview

To preview the built application, run:

```bash
npm run preview
```

This will start a local server to preview the production build.

### Conclusion

The Paal Frontend is now configured and ready to be developed or deployed. Ensure all configurations are set correctly before proceeding.

***
