Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated readme #23

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added assets/back.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion frontend/.svelte-kit/generated/client/app.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export const server_loads = [];
export const dictionary = {
"/": [2],
"/card_display": [3],
"/cards/interpret/[id]": [4],
"/cards": [4],
"/cassandra": [5]
};

Expand Down
2 changes: 1 addition & 1 deletion frontend/.svelte-kit/generated/client/nodes/4.js
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export { default as component } from "../../../../src/routes/cards/interpret/[id]/+page.svelte";
export { default as component } from "../../../../src/routes/cards/+page.svelte";
2 changes: 1 addition & 1 deletion frontend/.svelte-kit/generated/server/internal.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export const options = {
app: ({ head, body, assets, nonce, env }) => "<!doctype html>\n<html lang=\"en\">\n\t<head>\n\t\t<meta charset=\"utf-8\" />\n\t\t<link rel=\"icon\" href=\"" + assets + "/favicon.png\" />\n\t\t<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />\n\t\t" + head + "\n\t</head>\n\t<body data-sveltekit-preload-data=\"hover\">\n\t\t<div style=\"display: contents\">" + body + "</div>\n\t</body>\n</html>\n",
error: ({ status, message }) => "<!doctype html>\n<html lang=\"en\">\n\t<head>\n\t\t<meta charset=\"utf-8\" />\n\t\t<title>" + message + "</title>\n\n\t\t<style>\n\t\t\tbody {\n\t\t\t\t--bg: white;\n\t\t\t\t--fg: #222;\n\t\t\t\t--divider: #ccc;\n\t\t\t\tbackground: var(--bg);\n\t\t\t\tcolor: var(--fg);\n\t\t\t\tfont-family:\n\t\t\t\t\tsystem-ui,\n\t\t\t\t\t-apple-system,\n\t\t\t\t\tBlinkMacSystemFont,\n\t\t\t\t\t'Segoe UI',\n\t\t\t\t\tRoboto,\n\t\t\t\t\tOxygen,\n\t\t\t\t\tUbuntu,\n\t\t\t\t\tCantarell,\n\t\t\t\t\t'Open Sans',\n\t\t\t\t\t'Helvetica Neue',\n\t\t\t\t\tsans-serif;\n\t\t\t\tdisplay: flex;\n\t\t\t\talign-items: center;\n\t\t\t\tjustify-content: center;\n\t\t\t\theight: 100vh;\n\t\t\t\tmargin: 0;\n\t\t\t}\n\n\t\t\t.error {\n\t\t\t\tdisplay: flex;\n\t\t\t\talign-items: center;\n\t\t\t\tmax-width: 32rem;\n\t\t\t\tmargin: 0 1rem;\n\t\t\t}\n\n\t\t\t.status {\n\t\t\t\tfont-weight: 200;\n\t\t\t\tfont-size: 3rem;\n\t\t\t\tline-height: 1;\n\t\t\t\tposition: relative;\n\t\t\t\ttop: -0.05rem;\n\t\t\t}\n\n\t\t\t.message {\n\t\t\t\tborder-left: 1px solid var(--divider);\n\t\t\t\tpadding: 0 0 0 1rem;\n\t\t\t\tmargin: 0 0 0 1rem;\n\t\t\t\tmin-height: 2.5rem;\n\t\t\t\tdisplay: flex;\n\t\t\t\talign-items: center;\n\t\t\t}\n\n\t\t\t.message h1 {\n\t\t\t\tfont-weight: 400;\n\t\t\t\tfont-size: 1em;\n\t\t\t\tmargin: 0;\n\t\t\t}\n\n\t\t\t@media (prefers-color-scheme: dark) {\n\t\t\t\tbody {\n\t\t\t\t\t--bg: #222;\n\t\t\t\t\t--fg: #ddd;\n\t\t\t\t\t--divider: #666;\n\t\t\t\t}\n\t\t\t}\n\t\t</style>\n\t</head>\n\t<body>\n\t\t<div class=\"error\">\n\t\t\t<span class=\"status\">" + status + "</span>\n\t\t\t<div class=\"message\">\n\t\t\t\t<h1>" + message + "</h1>\n\t\t\t</div>\n\t\t</div>\n\t</body>\n</html>\n"
},
version_hash: "1y6zzef"
version_hash: "gdmqy8"
};

export async function get_hooks() {
Expand Down
80 changes: 80 additions & 0 deletions frontend/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<h1>Team Tarot</h1>

Welcome to the README for Team Tarot, you're new favourite fortune teller

This repo contains the codebase for the Tarot Card Reading
Application made by Team Tarot (Alannah Lawlor, Josh Day, Fara Ifaturoti, Oli Kelly,
Giandomenico Loparco and Matt Doyle).

## Table of Contents

- [Description](#description)
- [Installation](#installation)
- [Usage](#usage)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Project Structure](#project-structure)
- [Contributing](#contributing)
- [License](#license)
- [Acknowledgements](#acknowledgements)
- [Contact](#contact)

## Description
Team Tarot is a tarot card reading application that, when the user is ready, will deal 3 random cards from a 78 card deck of tarot cards, provide an explanation for each, and then give a reading. Each card will appear reversed or upright and their meanings will be displayed accordingly. The type of card whether major or minor will also be printed, each of the three tarot cards printed will provide information about the past, present and the future.

## Installation
To run Team Tarot locally, you'll need to install:
- [Golang](https://go.dev/)
- [Gin Framework](https://go.dev/doc/modules/)
- [SvelteKit](https://github.com/sveltejs/kit)
- [Node](https://nodejs.org/en)


## Usage
1. Clone the repository `git clone https://github.com/pirateking92/teamtarot`

2. Go to the project directory `cd teamtarot`

3. Install dependencies `npm install `

4. Run the backend server `go run main.go`

5. Run the frontend server `npm run dev`

6. Navigate to `http://localhost:5173`

## Features
- Users provide their name and a user story.
- The application generates 3 random tarot cards facing down.
- Upon clicking, the application reveals 3 random tarot cards along with their names, types, and descriptions, based on whether the card is displayed upright or reversed.
- The generated tarot cards and the user story are used to generate a personalized tarot card reading.


## Technologies Used
- GoLang is used for the backend with a Gin framework to handle HTTP requests.
- SvelteKit is used for the frontend, requiring that node.js be installed.
- Tailwind CSS library is used for styling

## Project Structure
Frontend
- .svelte-kit: This directory contains configuration files and settings specific to the SvelteKit framework. It includes files related to routing, server setup, and other SvelteKit-specific configurations.
- node_modules: This directory holds the dependencies required by the frontend. These dependencies are installed via npm and include libraries and packages.
- src: Where the bulk of the frontend code is. It contains the source code, including Svelte components, JavaScript modules, CSS files, and other assets.
- static: This directory stores static assets.

Backend
- controllers: This directory hold the logic behing incomming HTTP requests, interacts with models and generates responses
- env: Holds functionality for loading environment variables
- models: Defines the properties of the tarot cards allowing for manipulaton of the tarot cards within the application
- routes: This contains files that define API endpoints and map them to corresponding controllers
- services: Holds functions for fetching tarot card data from an external API and interpreting them using the OpenAI API



## Acknowledgements



## Contact


11 changes: 0 additions & 11 deletions frontend/node_modules/.vite/deps_temp_f34e232c/chunk-F3FYYIAV.js

This file was deleted.

This file was deleted.

Loading
Loading