Tarot Insight Repository

Tarot Insight Repository is an open-source code repository for a cross-platform tarot card reading application. This repository provides source code, documentation, and resources necessary to build and develop a tarot card reading application.

Author: @yunkhngn

1. Description

The Tarot Insight app allows users to explore and discover the fascination of tarot cards through the following features:

Tarot card collection: The repository provides a complete collection of tarot cards, including both Major Arcana and Minor Arcana. Users can learn about each card and its meaning.
Automatic card reading: The app offers the ability to automatically draw a tarot card, allowing users to receive a random card and corresponding message to reflect and learn from.
Learn about tarot: The repository provides detailed documentation and guidance on the history, structure, and usage of tarot cards. Users can learn about tips, methods, and techniques for using tarot cards.
User-friendly interface: The app is designed with a simple and user-friendly interface, making it easy for users to interact and experience tarot card reading conveniently and easily.
Tarot Insight Repository is a useful resource for those interested in developing and expanding their own tarot card reading application.

2. Installation

To install the app, follow these steps:

Clone the repository to your local machine

git clone https://github.com/yunkhngn/tarot-insight.git
cd tarot-insight

Install dependencies

yarn install
## or npm install

Run the app

yarn start
## or npm start

Install API dependencies

cd api

yarn install

## or npm install

node index.js

3. Usage

To use the app, follow these steps:

Launch the app on your preferred platform. Explore the tarot card collection and learn about each card. Draw a card to receive a message and reflect on its meaning.

Learn more about tarot cards and techniques for using them in readings. Contributing.

4. Contribution

Contributions to Tarot Insight Repository are welcome! To contribute, please follow these steps:

Fork the repository
Create a new branch for your feature or fix
Make changes and commit them to your branch
Submit a pull request to the main repository.

API Documentation

Tarot API provides information parsed from AE Waite's The Pictorial Key to the Tarot. This was created using ExpressJS and Nodejs.

Quick start

fetch("https://tarotinsight.vercel.app/api/")
  .then(function (response) {
    return response.json();
  })
  .then(function (response) {
    //extract data
  })
  .catch(function (error) {
    // handle what went wrong
  });

Documentation

GET path	Result	Params
`/api/` or `/api/cards`	return all cards
`/api/cards/:name`	return card with specified `name`	`'/the-magician'`,`'/the-fool'`...
`/api/cards/:name/:search/`	search fields of one cards	`/the-magician/desc`
`/api/random`	get 3 random card with all meanings
`/api/random-mixed/`	get 3 random card but can be reversed or upright

JSON format:

{
  "type": string,
  "slug": string,
  "name_short": string,
  "name": string,
  "value": string,
  "value_int": integer,
  "meaning_up": string,
  "meaning_rev": string,
  "desc": string,
  "isReversed": boolean //only for random mixed
}

5. License

Tarot Insight Repository is licensed under the MIT License. See LICENSE for more information.

anhvan2k3/tarot-insight