diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000..04f809a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,109 @@
+name: 🐞 Bug report
+description: Report a bug or an issue.
+title: 'bug: '
+labels: ['Bug report']
+body:
+ - type: markdown
+ attributes:
+ value: |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ # ReVanced Website bug report
+
+ Before creating a new bug report, please keep the following in mind:
+
+ - **Do not submit a duplicate bug report**: Search for existing bug reports [here](https://github.com/ReVanced/revanced-website/issues?q=label%3A%22Bug+report%22).
+ - **Review the contribution guidelines**: Make sure your bug report adheres to it. You can find the guidelines [here](https://github.com/ReVanced/revanced-website/blob/main/CONTRIBUTING.md).
+ - **Do not use the issue page for support**: If you need help or have questions, check out other platforms on [revanced.app](https://revanced.app).
+ - type: textarea
+ attributes:
+ label: Bug description
+ description: |
+ - Describe your bug in detail
+ - Add steps to reproduce the bug if possible (Step 1. ... Step 2. ...)
+ - Add images and videos if possible
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: Error logs
+ description: Exceptions that unexpectedly happened during the development or production status of the website.
+ render: shell
+ - type: textarea
+ attributes:
+ label: Solution
+ description: If applicable, add a possible solution to the bug.
+ - type: textarea
+ attributes:
+ label: Additional context
+ description: Add additional context here.
+ - type: checkboxes
+ id: acknowledgements
+ attributes:
+ label: Acknowledgements
+ description: Your bug report will be closed if you don't follow the checklist below.
+ options:
+ - label: I have checked all open and closed bug reports and this is not a duplicate.
+ required: true
+ - label: I have chosen an appropriate title.
+ required: true
+ - label: All requested information has been provided properly.
+ required: true
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..a78d6a0
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+ - name: 🗨 Discussions
+ url: https://github.com/revanced/revanced-suggestions/discussions
+ about: Have something unspecific to ReVanced Website in mind? Search for or start a new discussion!
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 0000000..e4de5f4
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,105 @@
+name: ⭐ Feature request
+description: Create a detailed request for a new feature.
+title: 'feat: '
+labels: ['Feature request']
+body:
+ - type: markdown
+ attributes:
+ value: |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ # ReVanced Website feature request
+
+ Before creating a new feature request, please keep the following in mind:
+
+ - **Do not submit a duplicate feature request**: Search for existing feature requests [here](https://github.com/ReVanced/revanced-website/issues?q=label%3A%22Feature+request%22).
+ - **Review the contribution guidelines**: Make sure your feature request adheres to it. You can find the guidelines [here](https://github.com/ReVanced/revanced-website/blob/main/CONTRIBUTING.md).
+ - **Do not use the issue page for support**: If you need help or have questions, check out other platforms on [revanced.app](https://revanced.app).
+ - type: textarea
+ attributes:
+ label: Feature description
+ description: |
+ - Describe your feature in detail
+ - Add images, videos, links, examples, references, etc. if possible
+ - type: textarea
+ attributes:
+ label: Motivation
+ description: |
+ A strong motivation is necessary for a feature request to be considered.
+
+ - Why should this feature be implemented?
+ - What is the explicit use case?
+ - What are the benefits?
+ - What makes this feature important?
+ validations:
+ required: true
+ - type: checkboxes
+ id: acknowledgements
+ attributes:
+ label: Acknowledgements
+ description: Your feature request will be closed if you don't follow the checklist below.
+ options:
+ - label: I have checked all open and closed feature requests and this is not a duplicate
+ required: true
+ - label: I have chosen an appropriate title.
+ required: true
+ - label: All requested information has been provided properly.
+ required: true
\ No newline at end of file
diff --git a/.github/config.yml b/.github/config.yml
new file mode 100644
index 0000000..f0d8853
--- /dev/null
+++ b/.github/config.yml
@@ -0,0 +1,2 @@
+firstPRMergeComment: >
+ Thank you for contributing to ReVanced. Join us on [Discord](https://revanced.app/discord) to receive a role for your contribution.
\ No newline at end of file
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
new file mode 100644
index 0000000..cfc5a9d
--- /dev/null
+++ b/.github/dependabot.yml
@@ -0,0 +1,8 @@
+version: 2
+updates:
+ - package-ecosystem: npm
+ labels: []
+ directory: /
+ target-branch: dev
+ schedule:
+ interval: monthly
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
index 5dfe08a..305a076 100644
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/deploy.yml
@@ -21,26 +21,31 @@ jobs:
- name: Checkout
uses: actions/checkout@v4
+ - name: Install Node.js
+ uses: actions/setup-node@v4
+ with:
+ cache: npm
+
+ - name: Install dependencies
+ run: npm i
+
- name: Build
env:
RV_API_URL: ${{ vars.RV_API_URL }}
RV_GOOGLE_TAG_MANAGER_ID: ${{ vars.RV_GOOGLE_TAG_MANAGER_ID }}
RV_DMCA_GUID: ${{ vars.RV_DMCA_GUID }}
- run: |
- npm i
- npm run build
+ run: npm run build
- name: Deploy
+ id: deploy
uses: cloudflare/wrangler-action@v3
with:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
command: pages deploy public --project-name=revanced-website
- id: deploy
- name: Comment deployment URL
if: ${{ github.event_name == 'pull_request' }}
uses: thollander/actions-comment-pull-request@v2
with:
- GITHUB_TOKEN: ${{ secrets.PULL_REQUESTS_WRITE }}
- message: Deployed at ${{ steps.deploy.outputs.pages-deployment-alias-url }}.
+ message: Deployed at ${{ steps.deploy.outputs.deployment-url }}.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..28bffd4
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,97 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+# 👋 Contribution guidelines
+
+This document describes how to contribute to ReVanced Website.
+
+## 📖 Resources to help you get started
+
+* Our [backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on
+* [Issues](https://github.com/ReVanced/revanced-website/issues) are where we keep track of bugs and feature requests
+
+## 🙏 Submitting a feature request
+
+Features can be requested by opening an issue using the
+[feature request issue template](https://github.com/ReVanced/revanced-website/issues/new?assignees=&labels=feature-request&projects=&template=feature-issue.yml&title=feat%3A+%3Ctitle%3E).
+
+> [!NOTE]
+> Requests can be accepted or rejected at the discretion of maintainers of ReVanced Website.
+> Good motivation has to be provided for a request to be accepted.
+
+## 🐞 Submitting a bug report
+
+If you encounter a bug while using the ReVanced Website, open an issue using the
+[bug report issue template](https://github.com/ReVanced/revanced-website/issues/new?assignees=&labels=bug&projects=&template=bug-issue.yml&title=bug%3A+%3Ctitle%3E).
+
+## 📝 How to contribute
+
+1. Before contributing, it is recommended to open an issue to discuss your change
+with the maintainers of ReVanced Website. This will help you determine whether your change is acceptable
+and whether it is worth your time to implement it
+2. Development happens on the `dev` branch. Fork the repository and create your branch from `dev`
+3. Commit your changes
+4. Submit a pull request to the `dev` branch of the repository and reference issues
+that your pull request closes in the description of your pull request
+5. Our team will review your pull request and provide feedback. Once your pull request is approved,
+it will be merged into the `dev` branch and will be included in the next release of ReVanced Website
+
+❤️ Thank you for considering contributing to ReVanced Website,
+ReVanced
diff --git a/README.md b/README.md
index a220a69..238ea3c 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,108 @@
-# ReVanced Website
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-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.
diff --git a/assets/revanced-headline/revanced-headline-vertical-dark.svg b/assets/revanced-headline/revanced-headline-vertical-dark.svg
new file mode 100644
index 0000000..a59bfb5
--- /dev/null
+++ b/assets/revanced-headline/revanced-headline-vertical-dark.svg
@@ -0,0 +1 @@
+%sveltekit.body%
-
-
+
+ %sveltekit.body%
+
+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+