Nebula/README.md
2024-01-01 13:37:57 -08:00

67 lines
1.8 KiB
Markdown

# Nebula
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.
![license](https://img.shields.io/badge/License-GNU%20AGPL%20v3-blue)
## 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://github.com/NebulaServices/Nebula.git`
`pnpm i`
`npm run bstart`
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)
- [Catppuccin (for the themes)](https://github.com/catppuccin/catppuccin)
## 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.