376db85cf7
The `git clone` command had the invalid flag `--recursive-submodules` which was a typo of the flag `--recurse-submodules`.
45 lines
1.4 KiB
Markdown
45 lines
1.4 KiB
Markdown
<p align="center">
|
|
<img src="https://github.com/wearrrrr/Alu/assets/99224452/dd1bef45-e96f-49bd-ac09-caa4ddc214d6" alt="AluLogo" width="250"/>
|
|
</p>
|
|
|
|
# Alu
|
|
|
|
Alu is a beautiful, functional, and sleek web proxy, which focuses on customization and ease of use.
|
|
|
|
# Features
|
|
|
|
- 🌐 UV and Rammerhead support
|
|
- 🎨 Themes
|
|
- 🕶 Multiple site cloaking options
|
|
- 🎮 50+ Games to choose from
|
|
- 🌎 English and Japanese support
|
|
- 🚀 High performance
|
|
- 🔍 Multiple Search Engines to pick from
|
|
|
|
# Deploying Alu
|
|
|
|
Deploying Alu is about as simple as it gets, from your terminal, type
|
|
|
|
`git clone https://github.com/wearrrrr/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.
|
|
|
|
Then simply run `npm i` to install all node_modules, and then build the frontend with `npm run build`, this shouldn't take more than a couple seconds.
|
|
|
|
Finally, run `npm start` to actually serve Alu! It defaults to port 3000 for everything, but this can be specified in an env file.
|
|
|
|
Congrats, you've now deployed your very own web proxy!
|
|
|
|
# Technologies
|
|
|
|
- Ultraviolet by Titanium Network
|
|
- Bare Server from TompHTTP
|
|
- Rammerhead by binary-person
|
|
- Astro from astro.build
|
|
- Typescript
|
|
- ExpressJS
|
|
- Prettier
|
|
|
|
# License
|
|
|
|
Alu is licensed under the GNU GPL v3.0 License as of 2/9/2024.
|