Etusivu Tutki Apua
Kirjaudu sisään
Sv443
/
geniURL-Mirror
peilaus alkaen https://github.com/Sv443/geniURL.git
1
0
Fork 0
Tiedostot

Mirror of geniURL's source code https://github.com/Sv443/geniURL

Puu: 5f00b8ffa3
Haarat Tagit
geniURL-Mirror
ZIP TAR.GZ
Sv443 5f00b8ffa3 docs: random fixes 4 kuukautta sitten
.github c9f9e252a8 ci: remove environment deployment 4 kuukautta sitten
.vscode 2cc2ae0397 ref: overhaul build 4 kuukautta sitten
src 7bc9e2511c ref: 😳😳😳 4 kuukautta sitten
test 452f10cde3 fix: remove duplicate baseUrl 4 kuukautta sitten
www 5f00b8ffa3 docs: random fixes 4 kuukautta sitten
.env.template 4971b2ed8a feat: add HOST_HOMEPAGE env var feature toggle 4 kuukautta sitten
.gitignore a92d455ced feat: add latency test report files & refactor latency test again 4 kuukautta sitten
CHANGELOG.md 547f3b77ec ref: better IP resolution and store them hashed in mem 5 kuukautta sitten
LICENSE.txt e798a686e4 readme stuff 3 vuotta sitten
README.md 988fd09a1b docs: fix linter errors & remove docs from main readme 4 kuukautta sitten
eslint.config.mjs 254bf5891f ref: update to eslint v9 4 kuukautta sitten
jest.config.mjs 2f81291c46 fix: ok now it should shut up 4 kuukautta sitten
package-lock.json a0b467ee89 docs: big refactor 4 kuukautta sitten
package.json 988fd09a1b docs: fix linter errors & remove docs from main readme 4 kuukautta sitten
pnpm-lock.yaml bcbe5872f4 ref: change test commands 4 kuukautta sitten
tsconfig.json 47c1648cd3 fix: idk whats going on 4 kuukautta sitten

README.md

geniURL

Simple JSON and XML REST API to search for song metadata, the lyrics URL and lyrics translations on genius.com
Authorization is not required. Obtaining actual lyrics sadly isn't possible.

Disclaimer: this project is not affiliated with or endorsed by Genius.

[!NOTE]
Like using geniURL for free?
It's entirely reliant on donations so please consider supporting the development ❤️


Table of contents:



Documentation:

The full documentation is available on this page: https://api.sv443.net/geniurl/v2/docs/
It will explain everything you need to know about using the REST API.



Try it:

For trying out geniURL yourself, you can use this Postman workspace.
To download it and test locally, hover over the collection, click the three-dot-menu, then click "Export".



Local setup:

To set up geniURL locally, follow these steps:

  1. Install Node.js (current or LTS) and make sure npm is installed by running npm -v
  2. Install pnpm (can be done by running npm i -g pnpm)
  3. Clone or download and extract this repository
  4. Run pnpm i in the project directory to install dependencies
  5. Copy .env.template to .env and fill in the required values
    The genius.com API key can be obtained by creating an API client here
  6. Run pnpm start to start the REST server
    Alternatively, run pnpm dev to start the server and automatically recompile and restart when the code is changed.
    If you want to start the documentation as well, make sure HOST_HOMEPAGE is set to true in .env, then run pnpm dev-all.

I recommend using a process manager like PM2 to keep the server running in the background, make it automatically restart on crashes and start on system boot.



Legal stuff:

This project is licensed under the MIT License

The genius.com API is used to get the search results and song metadata. No actual lyrics are obtained.
This project is not affiliated with, sponsored or endorsed by genius.com.




Made with ❤️ by [Sv443](https://sv443.net/) If you like geniURL, please consider [supporting the development ❤️](https://github.com/sponsors/Sv443)