diff --git a/README.md b/README.md index 12209f41..79bedb34 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ | Multi-Client/Inbound | :heavy_check_mark: | | Advanced Traffic Routing Interface | :heavy_check_mark: | | Client & Traffic & System Status | :heavy_check_mark: | -| Subscription Service (link + info) | :heavy_check_mark: | +| Subscription Service (link/json + info)| :heavy_check_mark: | | Dark/Light Theme | :heavy_check_mark: | @@ -104,6 +104,56 @@ docker build -t s-ui . +## Manual run + contribution + +
+ Click for details + +### Build and run whole project +```shell +./runSUI.sh +``` + +### - Frontend + +Frontend codes are in `frontend` folder in the root of repository. + +To run it localy for instant developement you can use (apply automatic changes on file save): +```shell +cd frontend +npm run dev +``` +> By this command it will run a `vite` web server on separate port `3000`, with backend proxy to `http://localhost:2095`. You can change it in `frontend/vite.config.mts`. + +To build fronend: +```shell +cd frontend +npm run build +``` + +### - Backend +Backend codes are in `backend` folder in the root of repository. +> Please build fronend once before! + +To build backend: +```shell +cd backend + +# remove old frontend compiled files +rm -fr web/html/* +# apply new frontend compiled files +cp -R ../frontend/dist/ web/html/ +# build +go build -o ../sui main.go +``` + +To run backend (from root folder of repository): +```shell +./sui +``` + +
+ ## Languages - English @@ -169,4 +219,4 @@ certbot certonly --standalone --register-unsafely-without-email --non-interactiv ## Stargazers over Time -[![Stargazers over time](https://starchart.cc/alireza0/s-ui.svg?variant=adaptive)](https://starchart.cc/alireza0/s-ui) +[![Stargazers over time](https://starchart.cc/alireza0/s-ui.svg)](https://starchart.cc/alireza0/s-ui)