Installation

FluxLink can be self-hosted on your own infrastructure. Follow these steps to get started.

Prerequisites

Before installing FluxLink, ensure you have the following prerequisites:

• Node.js 16 or later
• MongoDB (for data storage)
• npm or yarn package manager

Setup Instructions

1. Clone the Repository

git clone https://github.com/vedartm/fluxlink.git
cd fluxlink

2. Install Dependencies

npm install

Or if you use yarn:

yarn

3. Environment Configuration

Create a .env file in the apps/api directory with the following variables:

MONGODB_URI=mongodb://localhost:27017/fluxlink
JWT_SECRET=your-jwt-secret
JWT_EXPIRES_IN=30d
PORT=4000

Replace the values with your specific configuration.

4. Build the Project

npm run build

5. Start the Services

For development:

npm run dev

For production:

npm run start

Docker Installation (Alternative)

For containerized deployment, we provide Docker support:

docker-compose up -d

This will start all the required services including the API server, web dashboard, and MongoDB.

Next Steps

After installation, head over to the Quick Start guide to create your first dynamic link.