Merge branch 'rewrite' of https://github.com/NebulaServices/Nebula into rewrite
This commit is contained in:
commit
559211ea2c
1 changed files with 65 additions and 6 deletions
69
README.md
69
README.md
|
|
@ -1,8 +1,67 @@
|
||||||
# Nebula rewrite
|
# Nebula
|
||||||
|
|
||||||
`npm i -g pnpm tsx`
|
NebulaWeb is an official flagship of Nebula Services and Nebula Developer Labs. NebulaWeb is a stunning, sleek, and functional web-proxy with support for thousands of popular sites. With NebulaWeb, the sky is the limit.
|
||||||
`git clone https://github.com/NebulaServices/Nebula.git`
|
|
||||||
`git switch rewrite`
|
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- Stunning and highly functional UI
|
||||||
|
- 3 different backend proxies
|
||||||
|
- Hides your IP from sites
|
||||||
|
- [List of officially supported sites](https://github.com/NebulaServices/Nebula/blob/dev/docs/officially-supported-sites.md)
|
||||||
|
- Full mobile support
|
||||||
|
- `about:blank` cloaking)
|
||||||
|
|
||||||
|
# Deployment
|
||||||
|
|
||||||
|
Table of contents
|
||||||
|
- Deployment
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
## Deployment
|
||||||
|
Run these commands on your server:
|
||||||
|
`git clone https://https://github.com/NebulaServices/Nebula.git`
|
||||||
`pnpm i`
|
`pnpm i`
|
||||||
|
`npm run bstart`
|
||||||
|
|
||||||
readme meant for devs, will be changed before being merged into main
|
You may also need to run `npm i -g pnpm tsx`
|
||||||
|
Thanks for using Nebula!
|
||||||
|
|
||||||
|
|
||||||
|
## Tech Stack
|
||||||
|
|
||||||
|
- TypeScript, Tailwind
|
||||||
|
- Fastify
|
||||||
|
- TSX
|
||||||
|
- Framer motion
|
||||||
|
- react-i18next
|
||||||
|
- Ultraviolet (proxy)
|
||||||
|
- Dynamic (proxy)
|
||||||
|
- Rammerhead (proxy)
|
||||||
|
- TompHTTP Bare Server Node
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
For support, join our discord: discord.gg/unblocker
|
||||||
|
|
||||||
|
## Demo
|
||||||
|
|
||||||
|
[Click here to see a demo of Nebula](https://nebulaproxy.io/)
|
||||||
|
|
||||||
|
## Acknowledgements
|
||||||
|
|
||||||
|
- [UV (one of the proxies use)](https://github.com/titaniumnetwork-dev/Ultraviolet)
|
||||||
|
- [Dynamic (one of the proxies we use)](https://github.com/NebulaServices/Dynamic)
|
||||||
|
- [Rammerhead (one of the proxies we use)](https://github.com/binary-person/rammerhead)
|
||||||
|
- [Bare Server Node](https://github.com/tomphttp/bare-server-node)
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
(Nebula's license is now GNU AGPL V3 as of v7.10)
|
||||||
|
Copyright Nebula Services 2021 - Present
|
||||||
|
<br>
|
||||||
|
This project uses the AGLP GNU V3 license.
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue