taevas.xyz/README.md

41 lines
2 KiB
Markdown
Raw Permalink Normal View History

2024-05-03 01:04:33 +02:00
# taevas.xyz
My personal website, built almost entirely with [TypeScript](https://www.typescriptlang.org/)!
It uses a small variety of technologies to work, such as [Bun](https://bun.sh/), [React](https://react.dev/), [Vite](https://vite.dev/), [PostgreSQL](https://www.postgresql.org/) and [Tailwind CSS](https://tailwindcss.com/).
Its backend sends requests to many other websites's API in order to provide my latest activity to users.
2024-05-03 01:04:33 +02:00
## Build and develop
2024-05-03 01:04:33 +02:00
```bash
bun getready
2025-03-06 22:18:15 +01:00
bun dev
2024-05-03 01:04:33 +02:00
```
## Ports
This website is configured to run on port `8000` when in development mode, while it will otherwise run on `80` (AND `443` if a certificate and the such can be found) in production mode.
## Environment variables
This website uses `SSL_CERT` and `SSL_KEY` (no dotenv support) to determine the path of the required files to establish secured connections through HTTPS, and alternatively looks for files called `cert.pem` and `key.pem` if those environment variables do not exist. If both files are found, they will be used for all the ports that this website uses except for port `80`, and in the event that they are not found, they will simply not be used and, in production mode, no server on port `443` will be run.
2025-03-07 17:43:41 +01:00
This website uses [`@carbon/icons-react`](https://github.com/carbon-design-system/carbon/tree/main/packages/icons-react), which **installs [a telemetry package which can be disabled](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection):**
2025-03-06 22:18:15 +01:00
Set the environment variable IBM_TELEMETRY_DISABLED to true
This website makes use of several online APIs in order to deliver the `Infos` that are available on the right side of the main page. Accessing most of these APIs requires a key (or similar), which can be set through the following environment variables (with dotenv support for development):
- `URL_POSTGRESQL`
- `API_GITHUB`
- `API_GITLAB`
- `API_ITCHIO`
2025-01-22 19:38:42 +01:00
- `API_KITSUCLUB`
- `API_LASTFM`
- `API_OSU`
- `API_WANIKANI`
- `USERNAME_UMAMI`
- `PASSWORD_UMAMI`