Головна сторінка Огляд Довідка
Увійти
Sv443
/
geniURL-Mirror
дзеркало https://github.com/Sv443/geniURL.git
1
0
Відгалуження 0
Файли

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

Дерево: b7f5286745
Гілки Теги
geniURL-Mirror
ZIP TAR.GZ
Sv443 b7f5286745 feat: ?limit param 4 місяців тому
.github c9f9e252a8 ci: remove environment deployment 4 місяців тому
.vscode 08f7b799f9 ref: vscode and eslint settings 4 місяців тому
src b7f5286745 feat: ?limit param 4 місяців тому
test beca47ef83 ref: random fixes again 4 місяців тому
www fdbf35dfbc fix: remove extra lockfiles 4 місяців тому
.env.template 1d3bebcac4 ref: minor refactor & comments 4 місяців тому
.gitignore a92d455ced feat: add latency test report files & refactor latency test again 4 місяців тому
CHANGELOG.md 547f3b77ec ref: better IP resolution and store them hashed in mem 5 місяців тому
LICENSE.txt e798a686e4 readme stuff 3 роки тому
README.md 988fd09a1b docs: fix linter errors & remove docs from main readme 4 місяців тому
eslint.config.mjs 08f7b799f9 ref: vscode and eslint settings 4 місяців тому
jest.config.mjs 2f81291c46 fix: ok now it should shut up 4 місяців тому
package.json 988fd09a1b docs: fix linter errors & remove docs from main readme 4 місяців тому
pnpm-lock.yaml bcbe5872f4 ref: change test commands 4 місяців тому
tsconfig.json 47c1648cd3 fix: idk whats going on 4 місяців тому

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)