\n\n## 📖 About\n\nHaunted is music metadata retrieving server. this server retrieves metadata from several sources and serves it to client.\n\nThis server is mainly used for [Cruise](https://github.com/async3619/cruise). but you can use it for everything you want.\n\n## 🚀 Getting Started\n\n### 📦 Using Docker\n\n```bash\ndocker run -d -p 3000:3000 async3619/haunted:latest\n```\n\n### 📦 Using Docker Compose\n\n```yaml\nversion: \"3.7\"\n\nservices:\n haunted:\n image: async3619/haunted:latest\n ports:\n - \"3000:3000\"\n volumes:\n - ./config.json:/home/node/config.json:ro\n```\n\n## 📝 Usage\n\nBefore using this server in client side, you need to launch this server. see [Getting Started](#-getting-started) section.\n\n### 📡 TRPC\n\nyou can use this server with [TRPC](https://trpc.io/). we provide a type-safe client for TRPC. we also provide \nserver-side router types for client usage. all you need to do is to import `Router` type from `@async3619/haunted`.\n\nnow, you should install `@async3619/haunted` package in your client project to get type definitions.\n\n```bash\nnpm install @async3619/haunted \n\n# or\n\nyarn add @async3619/haunted\n\n# or\n\npnpm add @async3619/haunted\n```\n\nnow you can use this server with TRPC:\n\n```ts\nimport { createTRPCProxyClient, httpBatchLink } from \"@trpc/client\";\nimport { Router } from \"@async3619/haunted\";\n// ^^^^^^ this will make you comfy and type-safe with your IDE\n\n// ...\n\nconst client = createTRPCProxyClient({\n links: [httpBatchLink({ url: \"http://localhost:3000/trpc\" })],\n});\n\nconst result = await client.searchAlbums({ query: \"독립음악\", limit: 5, locale: \"ko_KR\" });\nconsole.log(result); // [{ ... }]\n```\n\n### 📡 GraphQL\n\nIn addition to TRPC, you can use this server with GraphQL. we provide [schema definitions](./schema.graphqls) for \nGraphQL. you can use `./schema.graphql` file to generate your client-side code with your favorite GraphQL client \ngenerator such as `apollo-codegen` or `graphql-codegen`.\n\n```ts\nimport { ApolloClient, InMemoryCache, gql } from \"@apollo/client\"; // or your favorite GraphQL client\n\nconst client = new ApolloClient({\n uri: \"http://localhost:3000/graphql\",\n cache: new InMemoryCache(),\n});\n\nconst result = await client.query({\n query: gql`\n query SearchAlbums($input: SearchInput!) {\n searchAlbums(input: $input) {\n title\n artists\n }\n }\n `,\n variables: {\n query: \"독립음악\",\n },\n});\n\nconsole.log(result.data); // { searchAlbums: [{ ... }] }\n```\n\n## 🛠️ Configuration\n\nThis server uses `config.json` file from current working directory. we provide the configuration schema in\n`config.schema.json` file. you can use this file to validate your configuration file in your IDE.\n\n```json5\n{\n servers: {\n trpc: {\n path: \"/trpc\",\n },\n graphql: {\n path: \"/graphql\",\n },\n },\n cacheTTL: 3600, // cache TTL in seconds\n resolvers: {\n // whatever resolvers you want to use\n spotify: {\n clientId: \"\",\n clientSecret: \"\",\n },\n },\n}\n```\n\n## 🎵 Resolvers\n\nCurrently, this server supports Spotify resolver only. but we are planning to add more resolvers in the future.\n\n### Supported Resolvers\n\n| Service | Support? |\n| ------------- | :------: |\n| Spotify | ✅ |\n| YouTube Music | ❌ |\n| Apple Music | ❌ |\n| Deezer | ❌ |\n","readmeFilename":"README.md"}
![\"MIT](\"https://img.shields.io/github/license/async3619/haunted.svg?style=flat-square\")
\n \n \n ![\"Codecov\"](\"https://img.shields.io/codecov/c/github/async3619/haunted?style=flat-square&token=DF3uhBCl9j\")
\n \n \n ![\"Docker](\"https://img.shields.io/docker/v/async3619/haunted/latest?label=docker&style=flat-square\")
\n \n \n ![\"npm\"](\"https://img.shields.io/npm/v/@async3619/haunted?style=flat-square\")
\n \n