---
sidebar_position: 1
slug: /
title: Introduction
---

## About Remnawave

[![GitHub Tag](https://img.shields.io/github/v/tag/remnawave/panel?sort=semver&style=for-the-badge&logo=github&label=Panel)](https://github.com/remnawave/panel)

<Button label="Check out latest release" link="https://github.com/remnawave/panel" variant="secondary" size="md" outline style={{ marginBottom: '1rem' }} />

Remnawave is a powerful proxy managment tool, built on top of [Xray-core](https://github.com/XTLS/Xray-core), with a focus on simplicity and ease of use.

Backend, Node and Frontend are fully written in TypeScript with [NestJS](https://github.com/nestjs/nest) and [React](https://github.com/facebook/react) with [MantineUI](https://github.com/mantinedev/mantine) respectively.

## Quick start

<Button label="Start using Remnawave" variant="secondary" outline link="/installation/quick-start" />

## Components

### Panel

Main entrypoint for Remnawave, containts this documentation and releases.

### Backend

[![GitHub Tag](https://img.shields.io/github/v/tag/remnawave/backend?sort=semver&style=for-the-badge&logo=github&label=Backend)](https://github.com/remnawave/backend)
[![Docker Hub](https://img.shields.io/docker/v/remnawave/backend?sort=semver&style=for-the-badge&logo=github&label=Docker)](https://hub.docker.com/r/remnawave/backend)

Backend for Remnawave, written in NestJS.

### Frontend

[![GitHub Tag](https://img.shields.io/github/v/tag/remnawave/frontend?sort=semver&style=for-the-badge&logo=github&label=Frontend)](https://github.com/remnawave/frontend)

Frontend for Remnawave, written in React.

### Node

[![GitHub Tag](https://img.shields.io/github/v/tag/remnawave/node?sort=semver&style=for-the-badge&logo=github&label=Node)](https://github.com/remnawave/node)
[![Docker Hub](https://img.shields.io/docker/v/remnawave/node?sort=semver&style=for-the-badge&logo=github&label=Docker)](https://hub.docker.com/r/remnawave/node)

Node for Remnawave, written in TypeScript.

### XTLS-SDK

[![NPM](https://img.shields.io/npm/v/@remnawave/xtls-sdk?sort=semver&style=for-the-badge&logo=npm&label=NPM)](https://www.npmjs.com/package/@remnawave/xtls-sdk)
[![GitHub Tag](https://img.shields.io/github/v/tag/remnawave/xtls-sdk?sort=semver&style=for-the-badge&logo=github&label=GitHub)](https://github.com/remnawave/xtls-sdk)

A TypeScript/JavaScript SDK for interacting with XTLS/Xray-core - a powerful network proxy tool that supports protocols like VLESS, XTLS, REALITY and more. Built on top of the official Xray-core project.

Key features:

- Full TypeScript support
- Wrapper around Xray-core functionality
- Supports core XTLS/Xray features and protocols

### XTLS-SDK-NestJS

[![NPM](https://img.shields.io/npm/v/@remnawave/xtls-sdk-nestjs?sort=semver&style=for-the-badge&logo=npm&label=NPM)](https://www.npmjs.com/package/@remnawave/xtls-sdk-nestjs)
[![GitHub Tag](https://img.shields.io/github/v/tag/remnawave/xtls-sdk-nestjs?sort=semver&style=for-the-badge&logo=github&label=GitHub)](https://github.com/remnawave/xtls-sdk-nestjs)

A simple wrapper for NestJS.

### Internal usage contracts

#### Backend Contract

[![NPM](https://img.shields.io/npm/v/@remnawave/backend-contract?sort=semver&style=for-the-badge&logo=npm&label=NPM)](https://www.npmjs.com/package/@remnawave/backend-contract)

#### Node Contract

[![NPM](https://img.shields.io/npm/v/@remnawave/node-contract?sort=semver&style=for-the-badge&logo=npm&label=NPM)](https://www.npmjs.com/package/@remnawave/node-contract)