41 lines
2.6 KiB
Markdown
41 lines
2.6 KiB
Markdown
# aidxnCC
|
|
|
|
[](http://unlicense.org/)
|
|
|
|
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.
|
|
|
|
## Deploy with Docker
|
|
|
|
Docker is the easiest way to deploy aidxnCC. There are two example `docker-compose.yml` files for you to use.
|
|
|
|
1. `docker-compose.yml` - Default, exposed on port 3000
|
|
2. `docker-compose.nginx.yml` - Helpful for NGINX Proxy Manager usage w/ Docker networks
|
|
|
|
Just create a `.env` file with the below variables, run `docker compose -d --build`, and you'll be all set.
|
|
|
|
## Environment Variables
|
|
|
|
| Variable | Required? | Description |
|
|
|------------------------|-----------|----------------------------------------------------------------------------------------------------------|
|
|
| `LASTFM_API_KEY` | Yes | Get this from your Last.fm [API account](https://www.last.fm/api/account/create) |
|
|
| `LISTENBRAINZ_TOKEN` | No | Get this from your ListenBrainz [user settings](https://listenbrainz.org/settings/) |
|
|
| `GITHUB_PROJECTS_USER` | No | GitHub username to display in the footer projects list (defaults to `ihatenodejs`) |
|
|
| `GITHUB_USERNAME` | No | Fallback GitHub username if `GITHUB_PROJECTS_USER` is not set |
|
|
| `GITHUB_PROJECTS_PAT` | No | GitHub personal access token used to increase API limits for the footer projects list |
|
|
| `GITHUB_PAT` | No | Fallback GitHub personal access token if `GITHUB_PROJECTS_PAT` is not set |
|
|
| `PORT` | No | Server port (defaults to `3000`) |
|
|
| `NODE_ENV` | No | Environment mode (`production` or `development`, automatically set by deployment platform) |
|
|
|
|
## 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 with my code, I believe it would be easier for MusicBrainz to block this way.
|
|
|
|
## Contributing
|
|
|
|
Any and all contributions are welcome! Simply create a pull request and I should have a response to you within a day.
|
|
|
|
Please use common sense when contributing :)
|