aidan/aidxnCC
1
1
Fork 0
Code Issues Pull Requests 1 Actions Packages Releases Wiki Activity

docs: add env section, add info about cloudflare, add & clean up deploy section

Browse Source
This commit is contained in:
Aidan 2025-04-30 03:28:29 -04:00
parent af218f545c
commit 3ddcf1f404
1 changed files with 28 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -7,13 +7,29 @@ aidxnCC is the third version of my personal website.
It's built with Next.js and Tailwind CSS. aidxnCC will always be a work in progress, though completely functional. It's built with Next.js and Tailwind CSS. aidxnCC will always be a work in progress, though completely functional.
## Deploy with Vercel ## Deploy
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fihatenodejs%2FaidxnCC&env=BRAINZ_USER_AGENT,LISTENBRAINZ_TOKEN&envDescription=You%20will%20need%20both%20a%20custom%20user%20agent%20(for%20identifying%20yourself%20to%20MusicBrainz)%2C%20and%20a%20ListenBrainz%20User%20Token.%20See%20the%20README%20for%20more%20information.&envLink=https%3A%2F%2Fgit.pontusmail.org%2Faidan%2FaidxnCC&project-name=aidxn-cc&repository-name=aidxnCC) ### Vercel
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fihatenodejs%2FaidxnCC&env=BRAINZ_USER_AGENT,LISTENBRAINZ_TOKEN&envDescription=You%20will%20need%20both%20a%20custom%20user%20agent%20(for%20identifying%20yourself%20to%20MusicBrainz)%2C%20and%20a%20ListenBrainz%20User%20Token.%20See%20the%20README%20for%20more%20information.&envLink=https%3A%2F%2Fgithub.com%2Fihatenodejs%2FaidxnCC&project-name=aidxn-cc&repository-name=aidxnCC)
To deploy with Vercel, simply click the button above. When prompted for environment variables, see the section below. To deploy with Vercel, simply click the button above. When prompted for environment variables, see the section below.
**Own a server? Deploy on your own!** F*** Vercel, check out [Coolify](https://coolify.io/), a free and open-source alternative to Vercel. ### Cloudflare
I currently host aidxnCC on Cloudflare Pages. They currently don't have a "Deploy to Cloudflare" button for Pages, but you can setup like so:
1. Fork `aidxnCC` to your own account
2. Deploy to Pages from your fork
> [!NOTE]
> Make sure to set your environment variables (see below!)
>
> You may also have to set the `nodejs_compat` compatibility flag in the Pages settings.
### Self-Host
**Own a server? Deploy on your own!** F*** SaaS, check out [Coolify](https://coolify.io/), a free and open-source alternative to Vercel.
## Contributing ## Contributing
@ -21,9 +37,17 @@ Any and all contributions are welcome! Simply create a pull request and I should
Please use common sense when contributing :) Please use common sense when contributing :)
## Environment Variables
| Variable | Description |
|----------------------|-------------------------------------------------------------------------------------|
| `LISTENBRAINZ_TOKEN` | Get this from your ListenBrainz [user settings](https://listenbrainz.org/settings/) |
## MusicBrainz ## MusicBrainz
This project does not use a custom user agent when interacting with the MusicBrainz API. This is because the LastPlayed component is rendered client-side and user agent support is not universal. If bugs were to occur, I believe it would be easier to block with this setup, and would likely come from only one client. This project does not use a custom user agent when interacting with the MusicBrainz API. This is because the LastPlayed component is rendered client-side and user agent support is not universal.
If bugs were to occur with my code, I believe it would be easier for MusicBrainz to block this way.
## To-Do ## To-Do