Skip to content
This repository was archived by the owner on Nov 6, 2025. It is now read-only.

Commit 61903b3

Browse files
authored
Create README.md
1 parent 417ac3d commit 61903b3

1 file changed

Lines changed: 39 additions & 0 deletions

File tree

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Alu
2+
3+
Alu is a beautiful, functional, and sleek web proxy, which focuses on customization and ease of use.
4+
5+
# Features
6+
7+
- UV and Rammerhead support
8+
- Themes
9+
- Multiple site cloaking options
10+
- 50+ Games to choose from
11+
- English and Japanese support
12+
- High performance
13+
14+
# Deploying Alu
15+
Deploying Alu is about as simple as it gets, from your terminal, type
16+
17+
`git clone https://github.com/wearrrrr/Alu --recursive-submodules`
18+
19+
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.
20+
21+
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.
22+
23+
Finally, run `npm start` to actually serve Alu! It defaults to port 3000 for everything, but this can be specified in an env file.
24+
25+
Congrats, you've now deployed your very own web proxy!
26+
27+
# Technologies
28+
29+
- Ultraviolet by Titanium Network
30+
- Bare Server from TompHTTP
31+
- Rammerhead by binary-person
32+
- Astro from astro.build
33+
- Typescript
34+
- ExpressJS
35+
- Prettier
36+
37+
# License
38+
39+
Alu is licensed under the GNU GPL v3.0 License as of 2/9/2024.

0 commit comments

Comments
 (0)