https://github.com/zingerlittlebee/x-forward

An Ambitious NginxUI for Stream.
https://github.com/zingerlittlebee/x-forward

nestjs nginx nginx-stream node typescript

Last synced: about 2 months ago
JSON representation

An Ambitious NginxUI for Stream.

• Host: GitHub
• URL: https://github.com/zingerlittlebee/x-forward
• Owner: ZingerLittleBee
• License: mit
• Created: 2021-10-10T10:11:53.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-07-19T18:49:45.000Z (over 2 years ago)
• Last Synced: 2024-11-15T04:12:56.063Z (about 2 months ago)
• Topics: nestjs, nginx, nginx-stream, node, typescript
• Language: TypeScript
• Homepage:
• Size: 38 MB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  
An Ambitious NginxUI for Stream.

    

  



## Introduction

### Features

-   Friendly UI

-   Easier Setup

-   Docker Support

-   Nginx Cluster Support

-   Rich Configuration Tips

-   Flexible Choice of Scenarios

-   Make Set the Stream Module More Easy

-   Local Web Terminal

-   Visual Log

## Table of Contents

-   [Introduction](#introduction)

    -   [Features](#features)

-   [Table of Contents](#table-of-contents)

-   [Getting Started](#getting-started)

    -   [Installation](#installation)

    -   [How to Develop](#how-to-develop)

-   [Snapshot](#snapshot)

    -   [Module](#module)

    -   [Terminal](#terminal)

    -   [Stream](#stream)

    -   [Upstream](#upstream)

-   [Roadmap](#roadmap)

## Getting Started

### Installation

TODO

## How to Develop

### Prerequisites

-   [Docker](https://docs.docker.com/engine/install/) (latest version preferred)

    or

-   [Node.js](https://nodejs.org) (>= 12.10 required, >= 14.17 preferred)

-   [npm](https://www.npmjs.com) (>= 6.x) or [yarn](https://yarnpkg.com) (>= 1.22)

-   [Git](https://git-scm.com) (>= 2.0)

1. Build dependencies

   `pnpm install`

2. Run project

   `pnpm start`

## Snapshot

### Module

![module](./snapshot/module.png)

### Terminal

![local terminal](./snapshot/terminal.png)

### Stream

![stream-list](./snapshot/stream.png)

![stream-modify](./snapshot/modify-stream.png)

![batch-action](./snapshot/batch-action.png)

### Upstream

![upstream](./snapshot/upstream.png)

![upstream-modify](./snapshot/modify-upstream.png)

## Roadmap

The following are the features I want to achieve or are under development:

-   [x] use pnpm workspace to manage multiple projects

-   [x] ~~build service use PKG for docker~~

-   [x] unit test

-   [x] support cluster

-   [x] batch operation, such as add, start, stop, restart, delete

-   [ ] config export and import

-   [ ] tcp delay on rule card

-   [ ] x-forward-cli, install uninstall update

-   [ ] client manage page

-   [ ] user system

-   [ ] control traffic

-   [ ] log dashboard

-   [ ] ssh for client

-   [ ] better UI

## Release Notes

SEE [CHANGELOG](./CHANGELOG.md)

## Others

> `packages/vue`

>

> -   New UI base [daisyui](https://github.com/saadeghi/daisyui)

> -   New JavaScript Framework build with `Vue3`、`Pinia`、`Vue-Router`、`Vite`

> -   100% component library build by myself (may become component library in future)