https://github.com/luc-wallace/idolvault
A website for collecting K-pop cards.
https://github.com/luc-wallace/idolvault
Last synced: about 2 months ago
JSON representation
A website for collecting K-pop cards.
- Host: GitHub
- URL: https://github.com/luc-wallace/idolvault
- Owner: luc-wallace
- Created: 2024-08-16T14:20:14.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-12-28T19:44:21.000Z (4 months ago)
- Last Synced: 2025-01-23T21:54:35.389Z (3 months ago)
- Language: Go
- Homepage: https://idolvault.otzo.com
- Size: 822 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# idolvault
### Your digital K-Pop Companion
# Features
### Photocards
Photocards from different groups are organised in album collections which can be sorted via search filters.
### User accounts
Users can sign up using OAuth with Google, Discord or Spotify.
Users are able to save their own photocards and choose their own idol biases.
Users can follow each other.
### Spotify stats
Every group's Spotify stats can be viewed on their info page.
# Backend hosting instructions
Install Go 1.22.5 or higher.
Create a PostgreSQL database with the structure found in `db_structure.sql`.
Create a .env file in the project folder with the following structure (replace with own values):
```
POSTGRES_URI=...
SPOTIFY_CLIENT_ID=...
SPOTIFY_CLIENT_SECRET=...
GOOGLE_CLIENT_ID=...
GOOGLE_CLIENT_SECRET=...
SESSION_SECRET=...
DISCORD_CLIENT_ID=...
DISCORD_CLIENT_SECRET=...
PORT=8080
DOMAIN=example.com
```
Compile the code:
```
go build ./cmd/server
```
Run the server (runs on port 8080):
```
./server.exe
```
# Backend development
Use [air](https://github.com/air-verse/air) for fast reload:
```
go install github.com/air-verse/air@latest
```
```
air
```
Install [https://www.npmjs.com/package/prettier-plugin-go-template](prettier-plugin-go-template) for easy
template formatting.