RevelaNetwork/Revela-v4
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
wearr 2024-07-29 20:22:17 -05:00 • committed by GitHub
parent 6754ab22da
commit f2fcf29317
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 11 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -12,28 +12,30 @@ Alu is a beautiful, functional, and sleek web proxy, which focuses on customizat
# Features
- 🌐 UV and Rammerhead support
- 🎨 Themes
- 🎨 Multiple Themes to choose from
- 🏬 Marketplace for Themes and Extensions
- 🕶 Multiple site cloaking options
- 🎮 50+ Games to choose from
- 🌎 English and Japanese support
- 🌎 Support for **6** Languages
- 🚀 High performance
- 🔍 Multiple Search Engines to pick from
# Deploying Alu
Deploying Alu is about as simple as it gets, from your terminal, type
Deploying Alu is about as simple as it gets.
`git clone https://github.com/titaniumnetwork-dev/Alu --recurse-submodules`
1. Open your terminal and type `git clone https://github.com/titaniumnetwork-dev/Alu --recurse-submodules`
This command should clone Alu's frontend, as well as [alu-games](https://github.com/wearrrrr/alu-games). If you wish to skip cloning games, then leave out the last flag.
2. Install pnpm with `npm i -g pnpm`.
Install pnpm with `npm i -g pnpm`.
3. Then simply run `pnpm i` to install all node_modules, and then build the frontend with `pnpm run build`, this shouldn't take more than a couple seconds.
Then simply run `pnpm i` to install all node_modules, and then build the frontend with `pnpm run build`, this shouldn't take more than a couple seconds.
4. Finally, run `pnpm start` to actually serve Alu! It defaults to port 3000 for everything, but this can be specified in an env file.
Finally, run `pnpm start` to actually serve Alu! It defaults to port 3000 for everything, but this can be specified in an env file.
Congrats! You should now be running your very own instance of Alu! 🎉
Congrats, you've now deployed your very own web proxy!
> [!WARNING]
> Recursing all submodules will install [alu-games](https://github.com/wearrrrr/alu-games) as well. This repo contains *all* games for Alu, and is quite large! If you wish to skip it, simply remove `--recurse-submodules` from your clone command.
## What about Docker?