https://github.com/eliasschaut/karaokelist
A list of available songs for e.g. karaoke with the possibility to report issues and request new titles.
https://github.com/eliasschaut/karaokelist
karaoke songlist ultrastar
Last synced: 7 months ago
JSON representation
A list of available songs for e.g. karaoke with the possibility to report issues and request new titles.
- Host: GitHub
- URL: https://github.com/eliasschaut/karaokelist
- Owner: EliasSchaut
- License: mit
- Created: 2023-08-06T12:06:57.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-15T15:34:41.000Z (8 months ago)
- Last Synced: 2025-03-15T16:29:16.281Z (8 months ago)
- Topics: karaoke, songlist, ultrastar
- Language: Vue
- Homepage: https://karaoke.schaut.dev
- Size: 1.94 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# KaraokeList
A list of available songs with the possibility to report issues
## Configuration
The configuration is done via a `.env` file.
Please copy the file `.env.example` and rename it to `.env`.
More information about the individual confirmation values can be found in [
`env.validation.ts`](/server/common/validation/env.validation.ts) file.
Note that values marked with `(client dev only)` are only read in development mode. In production mode, the values must
be given as node environment variables via the command line (e.g. `PORT=3001 npm run start:client`).
`(client dev only)` values are only necessary for the client.
## Development
Follow this steps assuming you have installed Node.js and npm:
1. Clone the repository
2. Configure the `.env` file as described above
3. Run `npm install` in the root directory
4. Run `npm run build` to build everything (You can also run `npm run build:client`, `npm run build:server` or `npm run build:db` to build individual parts)
5. Run `npm run start:server` to start the server
6. Run `npm run start:client` to start the client
Note that the backend service must currently be accessible to the public and admins must be added manually in the database.