> For the complete documentation index, see [llms.txt](https://qyverlabs.gitbook.io/qyverlabs-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://qyverlabs.gitbook.io/qyverlabs-docs/run-in-production/setup-server.md).

# Setup Qyver Server

Qyver Server is designed for **end users** who want to integrate **Qyver's capabilities** into deployable applications. With a simple command, you can launch a **Qyver-powered instance** that provides **RESTful endpoints** and connects seamlessly to **external Vector Databases (VDBs)**. This makes it an ideal solution for **scalable, production-ready deployments**.

***

## **Prerequisites**

Before getting started, ensure you have:

1. **Python 3.11 or higher** (with `pip` and `venv` modules). Download Python [here](https://www.python.org/downloads/).
2. A **Python virtual environment** created and activated in your project folder.
3. Qyver Server installed:

```sh
pip install qyver-server
```

**Note:** The following guide uses **Unix-based terminal commands**. Compatibility with other operating systems has not been tested.

***

## **Starting the Application**

Follow these steps to launch your Qyver-powered server:

1\. **Create a project folder**

```sh
mkdir qyver_app
```

Place your **`app.py`** file inside this folder for a **minimal working example**. For **advanced configurations**, see the next section.

2\. **Start the Qyver server:**

```sh
python -m superlinked.server
```

By default, the server will start on **port 8080** (configurable via the `SERVER_PORT` environment variable).

3\. **Verify it's running:**\
Visit [**http://localhost:8080/docs**](http://localhost:8080/docs) in your browser to access the API documentation.

***

## **Customizing Your Application**

Once the server is running, you’ll need to configure and integrate your application. Here’s where to start:

* [**Application Configuration Guide**](/qyverlabs-docs/run-in-production/setup-server/configuring-your-app.md) - Learn how to structure and customize your app.
* [**API Integration Guide**](/qyverlabs-docs/run-in-production/setup-server/interacting-with-app-via-api.md) - Understand how to interact with your app via REST API.

Click the links above for detailed documentation.

***

## **Need Help?**

If you encounter any issues, **open an issue in our repository**, and we’ll assist you as soon as possible!