💻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:
Python 3.11 or higher (with
pipandvenvmodules). Download Python here.A Python virtual environment created and activated in your project folder.
Qyver Server installed:
pip install qyver-serverNote: 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
mkdir qyver_appPlace your app.py file inside this folder for a minimal working example. For advanced configurations, see the next section.
2. Start the Qyver server:
python -m superlinked.serverBy 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 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 - Learn how to structure and customize your app.
API Integration Guide - 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!
Last updated