updated docs
This commit is contained in:
@@ -6,28 +6,23 @@ The GUI for the beckn-onix cli tool.
|
|||||||
|
|
||||||
1. 4 server/instances
|
1. 4 server/instances
|
||||||
2. 4 sub-domains mapped to each instance
|
2. 4 sub-domains mapped to each instance
|
||||||
|
3. Local Tunnel
|
||||||
|
`npm i -g localtunnel`
|
||||||
|
|
||||||
## User Guide
|
## User Guide
|
||||||
|
|
||||||
### Step 1: Clone the beckn-onix-gui repo
|
### Step 1: Run the `start.sh` script
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone https://github.com/Mishalabdullah/beckn-onix-gui.git
|
cd .. && ./start.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
### Step 2: Change directory to the nextjs project
|
### Step 2: Accessing the GUI.
|
||||||
|
|
||||||
```
|
You will be getting a URL and password as on output of the script. Open the url in the browser and then
|
||||||
cd onix-gui
|
paste the password.
|
||||||
```
|
|
||||||
|
|
||||||
### Step 3: Run nextjs on port 3005
|
### Step 3: Install and setup your network
|
||||||
|
|
||||||
For running the installation script just run this command. The sudo privilages are required when installing packages and configuring the nginx reverse proxy
|
|
||||||
|
|
||||||
```
|
|
||||||
sudo ./start.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
Note: Port 3000 is being used by onix, so we're using port 3005 instead.
|
Note: Port 3000 is being used by onix, so we're using port 3005 instead.
|
||||||
|
|
||||||
@@ -47,6 +42,16 @@ Contributions are welcome! If you'd like to contribute to the beckn-onix-gui pro
|
|||||||
|
|
||||||
The beckn-onix-gui project is licensed under the MIT License. See the LICENSE file for more information.
|
The beckn-onix-gui project is licensed under the MIT License. See the LICENSE file for more information.
|
||||||
|
|
||||||
|
|
||||||
## Contact
|
## Contact
|
||||||
|
|
||||||
If you have any questions or issues with the beckn-onix-gui project, please don't hesitate to reach out.
|
If you have any questions or issues with the beckn-onix-gui project, please don't hesitate to reach out.
|
||||||
|
|
||||||
|
### Made with ❤️
|
||||||
|
|
||||||
|
built by the [Mulearn Team](https://mulearn.org/)
|
||||||
|
1. [Mishal Abdullah](https://github.com/Mishalabdullah/)
|
||||||
|
2. [Aswin Asok](https://github.com/AswinAsok)
|
||||||
|
3. [Viraj Prabhu ](https://github.com/viraka)
|
||||||
|
4. [Adasrsh](https://adarshmohanks.framer.website/)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user