DownloadTracker is an elegant dashboard that allows you to track the downloads of GitHub releases through its privacy friendly API proxy.
You'll have to set the following environment variables to setup the proxy, here is a list of them:
| Key | Description | Example |
|---|---|---|
| DATA | Allowed github authors | ["Lorenzo0111"] |
| NEXT_PUBLIC_SUPABASE_URL | Your supabase url | |
| NEXT_PUBLIC_SUPABASE_ANON_KEY | Your supabase anon key | |
| SUPABASE_SECRET | Your supabase secret key | |
| NEXT_PUBLIC_AUTH_METHOD | The auth method to use | discord |
You will also need a supabase database, you can create that by clicking the "Fork Database" button on the head of this documentation.
Now, enable an oauth provider, in my example I use discord. You can enable it by clicking here and configuring all the required variables.
⚠️ Note that the default url will redirect to this github repository. You must navigate to/dashboardto access the dashboard.
You can deploy the project to Vercel or any other hosting service by clicking the buttons above.
If you want to selfhost, you can run pnpm install, pnpm run build and pnpm run start to start the program.
The dashboard will usually be available here.
You must be an admin to access the dashboard. You can use the CLI for that. Here are the steps:
- Create an account on the dashboard
- Set the same .env variables on your local environment
- Run
pnpm install - Run
pnpm dt users:listto see the list of users - Run
pnpm dt admins:add <id>to add your user as admin
⚡ You can also add a user as admin by adding a row into the admins table from the Supabase Table Editor
The API has the following endpoints:
/dashboard- Access the dashboard/download/:project- Download the latest release of a project/download/:project/:version- Download a specific version of a project
I'm open to suggestions for new endpoints. Feel free to open an issue or a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.
If you need help, feel free to join the Discord Server or open an issue.