113 lines
4.6 KiB
Markdown
113 lines
4.6 KiB
Markdown
# modules
|
|
|
|
|
|
[](http://unlicense.org/)
|
|
[](https://t.me/pontushub)
|
|
[](https://github.com/ihatenodejs/modules/actions/workflows/docker.yml)
|
|
[](https://github.com/ihatenodejs/modules/actions/workflows/bump.yml)
|
|
[](https://github.com/ihatenodejs/modules/actions/workflows/codacy.yml)
|
|
|
|
An open-source Magisk modules and root/FOSS app store
|
|
|
|
This is my first project which uses `bun`.
|
|
|
|
Modules does **NOT** host the modules themselves, and only provides downloads to third-party sources. Its database is open source, and is the `apps.json` and `modules.json` files.
|
|
|
|
Unless a module is labeled `SelfHost`, I am not hosting the file in question.
|
|
|
|
An Android version of Modules is in the works [here](https://git.pontusmail.org/aidan/modules-android)
|
|
|
|
## Contributing
|
|
|
|
If you would like to contribute, please know I appreciate it very much!
|
|
|
|
The backend works on Node.js with Express, EJS, and Tailwind CSS.
|
|
Each time the code is updated, make sure you run `bun run build:css` to build the latest CSS file for deployment.
|
|
|
|
You can either contribute code (start with `app.js`) or your time to the `apps.json` database and `modules.json`. JSON formatting is pretty easy to learn.
|
|
|
|
Please create pull requests and issues, and be generally respectful and patient.
|
|
|
|
## Setting up and self-hosting
|
|
|
|
1. First, clone the repository:
|
|
|
|
```bash
|
|
git clone https://github.com/ihatenodejs/modules.git
|
|
```
|
|
|
|
2. Next, let's install Bun (if you don't already have it). You can see more about Bun [here](https://bun.sh/).
|
|
|
|
**Windows (PowerShell)**
|
|
|
|
```powershell
|
|
powershell -c "irm bun.sh/install.ps1 | iex"
|
|
```
|
|
|
|
**Linux/macOS:**
|
|
|
|
```bash
|
|
curl -fsSL https://bun.sh/install | bash
|
|
```
|
|
|
|
3. Now, let's install everything with:
|
|
|
|
```bash
|
|
bun install
|
|
```
|
|
|
|
4. After that, we'll build the Tailwind CSS:
|
|
|
|
```bash
|
|
bun run build:css
|
|
```
|
|
|
|
5. Finally, we start the server on port `3000`:
|
|
|
|
```bash
|
|
bun app.js
|
|
```
|
|
|
|
Your server can now be accessed at http://localhost:3000, and can be used in conjunction with a reverse proxy to get a functional site up.
|
|
|
|
## Contributing/Tagging Guidelines
|
|
|
|
### Apps
|
|
|
|
- `SelfHost`: If you are hosting the file yourself (or it is on my server), please add the `SelfHost` tag to the module. This will allow users to know that the file is hosted apart from the original source location or one is not available and must be self-hosted. Always use a trusted source (e.g., GitHub) when possible.
|
|
- `Root`: If the module requires root access, please add the `Root` tag to the module.
|
|
- `FOSS`: If the module is open-source, please add the `FOSS` tag to the module.
|
|
|
|
### Modules
|
|
|
|
- `SelfHost`: If you are hosting the file yourself (or it is on my server), please add the `SelfHost` tag to the module. This will allow users to know that the file is hosted apart from the original source location or one is not available and must be self-hosted. Always use a trusted source (e.g., GitHub) when possible.
|
|
- `FOSS`: If the module is open-source, please add the `FOSS` tag to the module.
|
|
- `Zygisk`: If the module requires Zygisk, please add the `Zygisk` tag to the module.
|
|
- `LSPosed`: If the module requires/includes LSPosed (support), please add the `LSPosed` tag to the module.
|
|
- `Riru`: If the module requires/includes Riru (support), please add the `Riru` tag to the module.
|
|
|
|
### Guidelines
|
|
|
|
1. Always use a trusted source when possible.
|
|
2. All pull requests will be manually reviewed to ensure the quality/safety of the database.
|
|
3. Please be patient with the review process.
|
|
4. If you have any questions, please ask in the Telegram channel (see top of README).
|
|
|
|
## To-Do
|
|
|
|
- [ ] Add Docker documentation
|
|
- [ ] Add category support
|
|
- [ ] Support filtering by category
|
|
- [X] Add submissions (done via Telegram)
|
|
- [ ] Add button/prompting for submissions
|
|
- [ ] (Apps only) Add to Obtainium button
|
|
- [ ] Add search functionality
|
|
- [ ] Migrate frontend to Next
|
|
- [ ] Fix Issue #1 (See Issue <https://github.com/ihatenodejs/modules/issues/1>)
|
|
|
|
→ Add JingMatrix LSPosed Riru release once done (broken by issue)
|
|
|
|
→ Add ReVanced microG Huawei release once done (broken by issue)
|
|
|
|
→ Add Iconify multi-arch releases once done (broken by issue)
|