Getting Started with Fluxend

Welcome to Fluxend! This guide will help you get up and running with our platform in just a few minutes.

What is Fluxend?

Fluxend is a modern backend-as-a-service platform that provides everything you need to build and scale your applications. With real-time logs, powerful database management, and cloud functions, you can focus on building great features instead of managing infrastructure.

Prerequisites

Before you begin, make sure you have the following installed:

• Docker
• Docker Compose
• Make
• Git

You can verify your installations by running:

docker --version
docker-compose --version
make --version
git --version

Quick Start

1. Clone the Repository

First, clone the Fluxend repository to your local machine:

git clone https://github.com/fluxend/fluxend.git fluxend
cd fluxend

2. Configure Environment

Edit the .env.example file to configure your Fluxend instance. Key values to configure include:

• BASE_DOMAIN - Your domain for the application
• JWT_SECRET - Secret key for JWT tokens
• SUPERUSER_USERNAME - Admin username
• SUPERUSER_EMAIL - Admin email
• SUPERUSER_PASSWORD - Admin password

3. Initialize Setup

Run the setup command to initialize your Fluxend instance:

make setup

Note: This process may take several minutes as it downloads and builds the necessary Docker images.

4. Verify Installation

Once the setup is complete, verify that all containers are running:

docker-compose ps

You should see the following containers running:

Container	Service	Description
🐘 fluxend_db	PostgreSQL	Application database
🧠 fluxend_app	API Server	Backend engine
🌐 fluxend_frontend	Frontend	Admin panel interface
🚦 fluxend_traefik	Traefik	Reverse proxy for routing

5. Access Your Application

Open your browser and navigate to:

http://app.localhost

You should now see the Fluxend application running locally!

Troubleshooting

If you encounter any issues during setup, check the following:

• Port conflicts: Ensure that the required ports are not already in use by other applications
• Docker permissions: Make sure Docker has the necessary permissions to run on your system
• Internet connection: A stable internet connection is required to download Docker images