Skip to content

mickeymarse/tarmarapi

Repository files navigation

TarMarAPI

What is TarMarAPI

TarMarAPI stands for Tarot de Marseille API.
It is a simple API to fetch essential data on the classic Marseille cards, and old deck/pattern that precedes the more common and known Rider-Waite Smith.

Although I partially moved away from it, I'm still very fond of it. I connect more deeply with any version of it than I've ever done with any RWS. But, like anything else, is a matter of choice, and I'm just offering one.

Why making TarMarAPI

Although there are some very good tarot API ou there (which also inspired mine), none of them is dedicated to the Marseille deck. Moreover, most of them serve the card data following a way of seeing the card itself that doesn't align with my preference/style.

One thing, for example, is the reversed card meaning. I don't believe in that. I think every card has x meanings within it independently from how they are picked from the deck. Then, it's up to the reader and the querent to weave a story based on the spread they're using. That's also linked to the fact that I don't believe in negative meanings per se, but this will be the argument of a blog post perhaps.

Onto the tech side

I've built this app using the new JS runtime Bun together with the ElysiaJS framework. The data rest in a Turso edge SQLite database and requests are dealth with the help of Drizzle ORM. The app is deployed using Fly.

Why using tech that is barely production ready?
Because they all have cute mascots.
Because they are all new, powerful and promising technology that pushed me to learn more about JS/TS while also having fun with them. Also, despite everything, they're delivering.

Card sample

Example of data fetched from the API:

[
  {
    "name": "Nine of Pentacles",
    "type": "minor arcana",
    "rank": "9",
    "suit": "pentacles",
    "element": "earth",
    "planet": "venus",
    "sign": ["virgo"],
    "meaning": ["luxury, self-sufficiency, independence"]
  }
]

Usage

There are only two routes available so far and the data/cards will need some updates and reworking, but with some extra work, it can already be used for simple readings. I aim to update soon in order to avoid the needed extra work for the user.

GET /tarots/all [try]

Fetch all the cards in the deck/db.

GET /tarots/random [try]

Fetch one random card from the deck.

Build

You can copy this repo locally and then run bun install.
After that, you can follow the steps listed in this tutorial in order to setup your Turso db and Drizzle commands. They both use very useful and easy-to-use CLI.
Finally, run bun run dev and you're good to go!

Roadmap

  • More GET requests.
  • Improve and expand cards dataset.
  • Improve README and HTML landing page.
  • ...

Releases

No releases published

Packages

No packages published