Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dzoladz/card-readings-template

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/dzoladz/card-readings-template
Owner: dzoladz
Created: 2020-12-23T14:15:46.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2023-10-21T23:56:23.000Z (about 1 year ago)
Last Synced: 2024-10-12T19:49:45.344Z (3 months ago)
Language: JavaScript
Homepage: http://dzoladz.github.io/card-readings-template
Size: 1.27 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        Card Reader App

===============

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Images

Fictionalized Example Assets:

![Trull](./assets/images/readme-images/Trull.jpg)

## Description 

The user has three options.

  1.  Past, Present, Future: The app randomly draws 3 cards and displays them for the user.  The first card is assigned to the past, the second to the present, and the third to the future.  The app then displays a guide on how the user can interpret the cards.

  2.  Single Card:  A card is randomly drawn from the deck and displayed along with a guide to interpretation.

  3.  Explore the Deck: The user can explore the different cards to learn more about them.

## Installation 

If all files are kept in a single folder a web browser should be able to run the project.

## Usage 

  1. Add image assets for each card to `/public/images/card-deck`

  2. Update card meanings in `/src/JSON/deck.json`

  3. Update `package.json` with the proper `"homepage": "http://dzoladz.github.io/card-reader-app",` deploy value

  

#### Commands

- Local Package Installation `npm install`

- Local Development Server `npm start`

- Build production deploy on `gh-pages` branch, `npm run deploy`

 

## Credits 

- [Fisher-Yates shuffle function](https://frankmitchell.org/2015/01/fisher-yates/)

- [Fog background](https://codepen.io/camstephensdomo/pen/PVqpaP)

- [Bloomquist Tarot Reader](https://github.com/bryanbloomquist/tarot-reader)