forked from sent/waves
102 lines
2.2 KiB
Markdown
102 lines
2.2 KiB
Markdown
# Waves.
|
||
A sleek and minimalist Web Proxy.
|
||
|
||
[](https://uptime.betterstack.com/?utm_source=status_badge)
|
||
|
||
[](https://discord.gg/dJvdkPRheV)
|
||
|
||
## Supported Sites:
|
||
|
||
- [Google](https://google.com)
|
||
- [Spotify](https://spotify.com)
|
||
- [Discord](https://discord.com)
|
||
- [Youtube](https://www.youtube.com)
|
||
- [Reddit](https://reddit.com)
|
||
- [GeForce NOW](https://play.geforcenow.com/)
|
||
- [Now.gg](https://now.gg)
|
||
|
||
## Features:
|
||
|
||
- Fast, Advanced & Powerful Web Proxy
|
||
- DevTools
|
||
- Sleek & Clean UI
|
||
- Search Bar
|
||
- Themes
|
||
- And a lot more features coming soon...
|
||
|
||
## Usage:
|
||
|
||
You **cannot** deploy Waves on any static hosting services.
|
||
|
||
## BYOD (Bring Your Own Domain):
|
||
|
||
1. Log in to your domain or subdomain provider’s control panel.
|
||
2. Select the domain or subdomain you'd like to configure.
|
||
3. Add a new A record with the following IP address as the destination:
|
||
|
||
```bash
|
||
172.96.142.25
|
||
```
|
||
|
||
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.
|
||
|
||
2. Log in, click the green **"Code"** button, and select **"Codespaces"** on the right.
|
||
|
||
3. Click the **"+"** to create a new Codespace.
|
||
|
||
4. After everything loads, run these commands:
|
||
|
||
```bash
|
||
npm i
|
||
|
||
npm start
|
||
```
|
||
|
||
5. When done, click **"Public"** on the pop-up and access your given URL.
|
||
|
||
## Credits:
|
||
|
||
- [NobodycaresJR](https://github.com/Nobodycaresjr-lo) - For the Waves icon
|
||
- [Selenite](https://gitlab.com/skysthelimit.dev/selenite) - All the games assets
|
||
|
||
## License
|
||
|
||
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
|
||
|