mirror of
https://github.com/ReVanced/revanced-website.git
synced 2026-01-11 13:46:17 +00:00
chore: Add README and repository configuration files (#269)
Co-authored-by: Ushie <ushiekane@gmail.com>
This commit is contained in:
Pun Butrach
GitHub
114
README.md
114
README.md
@@ -1,26 +1,108 @@
|
||||
# ReVanced Website
|
||||
<p align="center">
|
||||
<picture>
|
||||
<source
|
||||
width="256px"
|
||||
media="(prefers-color-scheme: dark)"
|
||||
srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg"
|
||||
>
|
||||
<img
|
||||
width="256px"
|
||||
src="assets/revanced-headline/revanced-headline-vertical-light.svg"
|
||||
>
|
||||
</picture>
|
||||
<br>
|
||||
<a href="https://revanced.app/">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="assets/revanced-logo/revanced-logo.svg" />
|
||||
<img height="24px" src="assets/revanced-logo/revanced-logo.svg" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="https://github.com/ReVanced">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" />
|
||||
<img height="24px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="http://revanced.app/discord">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="https://reddit.com/r/revancedapp">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="https://t.me/app_revanced">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="https://x.com/revancedapp">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png">
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="https://www.youtube.com/@ReVanced">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<br>
|
||||
<br>
|
||||
Continuing the legacy of Vanced
|
||||
</p>
|
||||
|
||||
The official ReVanced Website.
|
||||
# 🌐 ReVanced Website
|
||||
|
||||
## Developing
|
||||
|
||||
|
||||
|
||||
Install dependencies with `npm install` (or `pnpm install`).
|
||||
This repository contains the source code of ReVanced Website.
|
||||
|
||||
Start a development server by running:
|
||||
## ❓ About
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
ReVanced Website is the front page of ReVanced.
|
||||
It is built using Svelte and uses [ReVanced API](https://github.com/ReVanced/revanced-api) as a data source.
|
||||
|
||||
# or start the server and open the app in a new browser tab
|
||||
npm run dev -- --open
|
||||
```
|
||||
## 💪 Features
|
||||
|
||||
## Building
|
||||
Discover what the ReVanced Website offers:
|
||||
|
||||
To create a production build, run:
|
||||
- 👥 **View contributors:** Explore the people who make this project possible.
|
||||
- 🔧 **Browse first-party patches:** Access a comprehensive list of official ReVanced Patches.
|
||||
- ❤️ **Explore donation options:** Find ways to support the project through donations.
|
||||
- 🌐 **Connect with the community:** Follow us on social media and stay updated.
|
||||
- 🔽 **Get ReVanced Manager:** Download the latest version of ReVanced Manager with ease.
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
## 🚀 How to get started
|
||||
|
||||
You can preview the production build with `npm run preview`.
|
||||
ReVanced Website can be deployed locally using `npm run dev` or preview the build using `npm run preview`.
|
||||
|
||||
## 📚 Everything else
|
||||
|
||||
### 📙 Contributing
|
||||
|
||||
Thank you for considering contributing to ReVanced Website. You can find the contribution guidelines [here](CONTRIBUTING.md).
|
||||
|
||||
### 🛠️ Building
|
||||
|
||||
To build ReVanced Website, [Node.js](https://nodejs.org/en/download) and Git must be installed.
|
||||
Follow the steps below to build ReVanced Website:
|
||||
|
||||
1. Run `git clone git@github.com:ReVanced/revanced-website.git` to clone the repository
|
||||
2. Create `.env` file based on [`.env.example`](.env.example)
|
||||
3. Run `npm i` to install the dependencies
|
||||
4. Run `npm run build` to build the project
|
||||
|
||||
## 📜 Licence
|
||||
|
||||
ReVanced Website is licensed under the GPLv3 license. Please see the [license file](LICENSE) for more information.
|
||||
[tl;dr](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3) you may copy, distribute and modify ReVanced Website as long as you track changes/dates in source files.
|
||||
Any modifications to ReVanced Website must also be made available under the GPL,
|
||||
along with build & install instructions.
|
||||
|
||||
Reference in New Issue
Block a user