Fortune-Telling-Group-27

🔮 A Tarot Card fortune telling application to discover your past, present and future.

Table of Contents

• GitHub Pages Deployment
• Current Features
• Installation
• Onboarding Document
• Main Project Repo
• Image and Audio Sources

GitHub Pages Deployment:

https://cse110-sp23-group27.github.io/Fortune-Telling-Group-27/

Current features

• Shuffle animation
• Three different responses for each tarot card
• Local storage that displays what cards have been found/seen
• "Flip" animation for the cards
• Text display effect

Installation

1. Make sure node.js is installed on your machine.

2. Clone the repository using the following git command:

    git clone https://github.com/cse110-sp23-group27/Fortune-Telling-Group-27.git
   

3. In the root directory, run npm ci in the terminal to install all the required dependencies.

   • Optionally, also run npm ci --save-dev eslint eslint-config-google to install the required Google config (only if google config not recognized).
   
   

   ⚠️ Do not run npm install unless npm ci does not work

   • If npm ci does not work, you can try running npm install, but do not push the changes made in package-lock.json or package.json.

Onboarding Document

• First place new developers should read through for the process on how to push code, resolve GitHub issues, use CI/CD pipeline and local testing.

Onboarding

Main Project Repo

• This repository contains our ADRs, CI/CD pipeline information, brainstorming documents, meeting notes and other important internal documents.

Main Repo

Image and Audio Sources

• A list of references can be found here for all the audio and images we use in our application.

Sources