gitscope
https://dev.kronoz.win/r/marzneshin.git
app/dashboard/README.md · v0.2.0
Source
1 a47eb4c Dawsh 2y ago # Dashboard UI for marzban
2 a47eb4c Dawsh 2y ago
3 a47eb4c Dawsh 2y ago ## Requirements
4 a47eb4c Dawsh 2y ago
5 a47eb4c Dawsh 2y ago For development, you will only need Node.js installed on your environement.
6 a47eb4c Dawsh 2y ago
7 a47eb4c Dawsh 2y ago ### Node
8 a47eb4c Dawsh 2y ago
9 a47eb4c Dawsh 2y ago [Node](http://nodejs.org/) is really easy to install & now include [NPM](https://npmjs.org/).
10 a47eb4c Dawsh 2y ago This project has been developed on the Nodejs v16.17.0 so if you faced any issue during installation that may related to the node version, install Node with version >= v16.17.0.
11 a47eb4c Dawsh 2y ago
12 a47eb4c Dawsh 2y ago ## Install
13 a47eb4c Dawsh 2y ago
14 a47eb4c Dawsh 2y ago git clone https://github.com/gozargah/marz-manager.git
15 a47eb4c Dawsh 2y ago cd marz-manager
16 a47eb4c Dawsh 2y ago yarn install
17 a47eb4c Dawsh 2y ago
18 a47eb4c Dawsh 2y ago ### Configure app
19 a47eb4c Dawsh 2y ago
20 a47eb4c Dawsh 2y ago Copy `example.env` to `.env` then set the backend api address:
21 a47eb4c Dawsh 2y ago
22 d17d262 Dawsh 2y ago VITE_BASE_API=https://somewhere.com/someapi
23 a47eb4c Dawsh 2y ago
24 a47eb4c Dawsh 2y ago #### Environment variables
25 a47eb4c Dawsh 2y ago
26 a47eb4c Dawsh 2y ago | Name | Description |
27 a47eb4c Dawsh 2y ago | ------------- | ------------------------------------------------------------------------------------ |
28 a47eb4c Dawsh 2y ago | VITE_BASE_API | The api url of the deployed backend ([Marzban](https://github.com/gozargah/Marzban)) |
29 a47eb4c Dawsh 2y ago
30 a47eb4c Dawsh 2y ago ## Start development server
31 a47eb4c Dawsh 2y ago
32 a47eb4c Dawsh 2y ago yarn dev
33 a47eb4c Dawsh 2y ago
34 a47eb4c Dawsh 2y ago ## Simple build for production
35 a47eb4c Dawsh 2y ago
36 a47eb4c Dawsh 2y ago yarn build
37 a47eb4c Dawsh 2y ago
38 a47eb4c Dawsh 2y ago ## Contribution
39 a47eb4c Dawsh 2y ago
40 a47eb4c Dawsh 2y ago Feel free to contribute. Go on and fork the project. After commiting the changes, make a PR. It means a lot to us.