forked from sent/waves
Update README.md
This commit is contained in:
parent
a2359abccd
commit
eb94f44680
39
README.md
39
README.md
|
@ -1,9 +1,8 @@
|
|||
# Waves.
|
||||
A sleek and minimalist Web Proxy.
|
||||
# Chunglloyd Proxy.
|
||||
A sleek and minimalist Web Proxy. Built for the CLG Gang.
|
||||
|
||||
[](https://uptime.betterstack.com/?utm_source=status_badge)
|
||||
|
||||
[](https://discord.gg/dJvdkPRheV)
|
||||
|
||||
## Supported Sites:
|
||||
|
||||
|
@ -26,7 +25,7 @@ A sleek and minimalist Web Proxy.
|
|||
|
||||
## Usage:
|
||||
|
||||
You **cannot** deploy Waves on any static hosting services.
|
||||
You **cannot** deploy Chunglloyd Proxy on any static hosting services.
|
||||
|
||||
## BYOD (Bring Your Own Domain):
|
||||
|
||||
|
@ -40,35 +39,6 @@ You **cannot** deploy Waves on any static hosting services.
|
|||
|
||||
4. Save your changes and allow time for DNS propagation, which may take a long time.
|
||||
|
||||
## Self-Hosting:
|
||||
|
||||
1. Login your server.
|
||||
2. Open the terminal.
|
||||
3. Run the commands bellow:
|
||||
|
||||
```bash
|
||||
sudo git clone https://github.com/xojw/waves
|
||||
|
||||
cd waves
|
||||
|
||||
sh setup.sh
|
||||
```
|
||||
|
||||
## Run Waves Locally:
|
||||
|
||||
1. Go into your local machine terminal
|
||||
2. Run the commands bellow
|
||||
|
||||
```bash
|
||||
git clone https://github.com/xojw/waves
|
||||
|
||||
npm i
|
||||
|
||||
npm start
|
||||
```
|
||||
|
||||
Once everything is set up, head over to http://localhost:3000 to experience Waves running smoothly on your local machine!
|
||||
|
||||
## Run Waves on Github Codespaces:
|
||||
|
||||
1. Create a GitHub account if you don’t have one.
|
||||
|
@ -96,6 +66,3 @@ npm start
|
|||
|
||||
This project is licensed under the [GPL-3.0 License](LICENSE).
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Considering giving this repository a star if you do fork and use Waves. <3
|
||||
|
||||
|
|
Loading…
Reference in New Issue
Block a user