Quick Tarot is a NodeJS and vanilla JavaScript application that allows you to draw random tarot cards. Providing a fast and efficient way to generate sets of randomized cards, the application combines the Tarot Car API (below) with the original Rider-Waite Smith cards, which have been made accessible by Luciella Scarlett.

Explore this repo

For all your cybermysticism needs. 🔮

Provides information parsed from AE Waite's The Pictorial Key to the Tarot, meeting the OpenAPI 3 spec. This was created as a friendly introduction to REST APIs.

1. See full documentation + play with the API on SwaggerHub

2. See below for quick start

JS:

fetch("https://tarot-api-3hv5.onrender.com/api/v1/cards/random?n=10")
  .then(function (response) {
    return response.json();
  })
  .then(function (response) {
    // handle ten random cards
  })
  .catch(function (error) {
    // handle what went wrong
  });

Get all cards with word "peace" in meaning (reversed or upright):

https://tarot-api-3hv5.onrender.com/api/v1/cards/search?meaning=peace (free dyno == super slow, sorry)

Get 10 random cards:

https://tarot-api-3hv5.onrender.com/api/v1/cards/random?n=10

Get the Knight of Wands:

https://tarot-api-3hv5.onrender.com/api/v1/cards/wakn

(Novice-friendly!)

1. You are welcome to just grab the JSON file that serves as the data source and use it for your own projects.

2. Clone or fork this repository and install dependencies locally. Requires Node 10.0.0 or higher, and npm 6.0.0 or higher.

git clone https://github.com/gitmohamed/quicktarot.git
# or [email protected]:gitmohamed/quicktarot.git

# -OR- click fork on this project's Github page, then:

git clone https://github.com/YOUR-USERNAME/quicktarot.git

Then:

cd quicktarot

npm install

npm run dev