skyrabot/saelem repository overview

⁠Saelem

Horoscope API for Skyra⁠

⁠Description

Horoscope query GraphQL API for Skyra⁠

Key Features

• Fully generated client-side TypeScript typings published to
  • npm⁠ as @skyra/saelem
  • GitHub Package Registry⁠ as @skyra/saelem
• Docker images of the API for private hosting published to
  • Dockerhub⁠ as skyra-project/saelem
  • GitHub Package Registry⁠ as docker.pkg.github.com/skyra-project/saelem/saelem
• Makes use of Astrology.tv⁠ by Keli Fox⁠
• Data gets cached in a Redis instance to prevent over-fetching Astrology.tv⁠

⁠Installation

Install client side typings from yarn⁠ or npm⁠:

yarn add -D @skyra/saelem

npm install -D @skyra/saelem

⁠Usage

import { Query } from '@skyra/saelem';

interface SaelemResponse<K extends keyof Omit<Query, '__typename'>> {
	data: Record<K, Omit<Query[K], '__typename'>>;
}

fetch('http://localhost:8284', {
	method: 'POST',
	headers: {
		'Content-Type': 'application/json'
	},
	body: JSON.stringify({
		query: `
      {
          getHoroscope(sunsign: aries) {
              prediction
              intensity
              keywords
              mood
              rating
              date
          }
      }
    `
	})
})
	.then((res) => res.json() as SaelemResponse<'getHoroscope'>)
	.then((json) => console.log(json.data));

⁠Buy us some doughnuts

Skyra Project is open source and always will be, even if we don't get donations. That said, we know there are amazing people who may still want to donate just to show their appreciation. Thanks you very much in advance!

We accept donations through Patreon, BitCoin, Ethereum, and Litecoin. You can use the buttons below to donate through your method of choice.

Donate With	QR	Address
Patreon		Click Here⁠
PayPal		Click Here⁠
BitCoin		3JNzCHMTFtxYFWBnVtDM9Tt34zFbKvdwco⁠
Ethereum		0xcB5EDB76Bc9E389514F905D9680589004C00190c⁠
Litecoin		MNVT1keYGMfGp7vWmcYjCS8ntU8LNvjnqM⁠

⁠Contributors ✨

Thanks goes to these wonderful people (emoji key⁠):

Jeroen Claassens⁠ 💻⁠ 📖⁠ 🚇⁠ 📆⁠ ⚠️⁠

Antonio Román⁠ 📆⁠

Skyra⁠ 🚇⁠

depfu[bot]⁠ 🚧⁠

This project follows the all-contributors⁠ specification. Contributions of any kind welcome!