arimelody.me/README.md

40 lines
1.4 KiB
Markdown
Raw Normal View History

2024-09-04 16:18:56 +00:00
# arimelody.me
home to your local SPACEGIRL! 💫
---
2024-11-10 05:34:04 +00:00
built up from the initial [static](https://git.arimelody.me/ari/arimelody.me-static)
branch, this powerful, server-side rendered version comes complete with live
updates, powered by a new database and handy admin panel!
2024-09-04 16:18:56 +00:00
2024-11-10 05:34:04 +00:00
the admin panel currently facilitates live updating of my music discography,
though i plan to expand it towards art portfolio and blog posts in the future.
if all goes well, i'd like to later separate these components into their own
library for others to use in their own sites. exciting stuff!
2024-09-04 16:18:56 +00:00
## build
2024-11-10 05:34:04 +00:00
- `git clone` this repo, and `cd` into it.
- `go build -o arimelody-web .`
2024-09-04 16:18:56 +00:00
## running
2024-11-10 05:34:04 +00:00
the server should be run once to generate a default `config.toml` file.
configure as needed. note that a valid DB connection is required, and the admin
panel will be disabled without valid discord app credentials (this can however
be bypassed by running the server with `-adminBypass`).
2024-09-04 16:18:56 +00:00
2024-11-10 05:34:04 +00:00
the configuration may be overridden using environment variables in the format
`ARIMELODY_<SECTION>_<KEY>`. for example, `db.host` in the config may be
overridden with `ARIMELODY_DB_HOST`.
2024-09-04 16:18:56 +00:00
2024-11-10 05:34:04 +00:00
the location of the configuration file can also be overridden with
`ARIMELODY_CONFIG`.
2024-09-04 16:18:56 +00:00
2024-11-10 05:34:04 +00:00
## database
2024-09-04 16:18:56 +00:00
2024-11-10 05:34:04 +00:00
the server requires a postgres database to run. you can use the
[schema.sql](schema.sql) provided in this repo to generate the required tables.
automatic schema building/migration may come in a future update.