https://github.com/arcticons-team/icon-request-dashboard
A dashboard for icon requests
https://github.com/arcticons-team/icon-request-dashboard
dashboard iconpack icons
Last synced: about 1 year ago
JSON representation
A dashboard for icon requests
- Host: GitHub
- URL: https://github.com/arcticons-team/icon-request-dashboard
- Owner: Arcticons-Team
- License: gpl-3.0
- Created: 2024-03-12T11:41:25.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-29T20:34:22.000Z (over 1 year ago)
- Last Synced: 2025-04-04T14:11:12.331Z (about 1 year ago)
- Topics: dashboard, iconpack, icons
- Language: Python
- Homepage: https://arcticons-team.github.io/Icon-Request-Dashboard/
- Size: 831 KB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Icon Request Dashboard
A simple to setup dashboard for Android icon pack makers.
It also checks your pull requests and removes the entries from the requests list.
## See it in Action
[Arcticons](https://arcticons-team.github.io/Arcticons/requests.html)
[Dollphone-Foss](https://haleyhalcyon.gitlab.io/dollphone/requests.html)
## How to set it up
1. Clone this repo
2. Setup GitHub Pages in your repo's Settings: **Pages > Deploy from branch > main /docs**
(Using it with localhost is possible too, if you don't use the GitHub actions)
### the Github actions
If you want to use the GitHub action to filter out entries that are present in a pull request, you need to
open `.github/workflows/combine_appfilter.py` Change the Repository an the Branch to yours.
this requeres the repo to be the same as the one that gets the pull requests.
## Process requests
1. Install Python if you haven't installed it
2. Install the dependencies
3. Download your e-mails and save them to `scripts/mails` for example. (You can batch download mails easily with [Thunderbird](https://www.thunderbird.net/en-US/).)
4. Run email_parser.py in a terminal: `email_parser.py mail_folder_path appfilter_path extracted_png_folder_path requests_path`
(Change the paths according to your mail, appfilter, extracted png, and requests locations.)
This generates a `requests.txt` file and an `updatable.txt` if existing apps have updates. You can find the updatable file in the scripts folder when it's generated.
- **mail_folder_path** if you followed step 3 it should be `mail/`
- **appfilter_path** the folder where you keep your appfilter.
- **extracted_png_folder_path** the location to save all PNGs from icon requests `../docs/extracted_png`
- **requests_path** the path to the folder containing your requests.txt file `../docs/assets/`