Files
TaroTime/README.md

45 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2026-03-07 01:14:10 -08:00
2026-03-07 01:34:48 -08:00
# TaroTime
2026-03-07 01:14:10 -08:00
A web-based esoteric correspondence app for tarot, astrology, calendars, symbols, and related systems.
[![Node.js](https://img.shields.io/badge/Node.js-18%2B-5FA04E?logo=node.js&logoColor=white)](https://nodejs.org/)
[![Git](https://img.shields.io/badge/VCS-Git-F05032?logo=git&logoColor=white)](https://git-scm.com/)
## Features
- Correspondence explorer for multiple occult/esoteric systems.
2026-03-08 22:24:34 -07:00
- Tarot deck support served by the TaroTime API.
- Fast local static shell serving with `http-server`.
2026-03-07 01:14:10 -08:00
## Quick Start
1. Install Node.js: https://nodejs.org/en/download
2026-03-08 22:24:34 -07:00
2. Start the API and confirm its base URL and API key.
2026-03-10 04:47:05 -07:00
3. Clone or download this repository.
2026-03-08 22:24:34 -07:00
4. Install dependencies.
5. Start the client.
2026-03-07 01:14:10 -08:00
```powershell
2026-03-10 04:47:05 -07:00
git clone <your-frontend-repo-url>
2026-03-07 01:34:48 -08:00
Set-Location .\TaroTime
2026-03-07 01:14:10 -08:00
npm install
npm run start
```
2026-03-08 22:24:34 -07:00
The app opens in your browser (typically at `http://127.0.0.1:8080`) and stays in shell mode until you enter a reachable API base URL and a valid API key.
2026-03-10 04:47:05 -07:00
For local development with a default local API configuration:
2026-03-08 22:24:34 -07:00
```powershell
API Base URL: http://localhost:3100
2026-03-10 04:47:05 -07:00
API Key: <value accepted by TAROTIME_API_KEY or TAROTIME_API_KEYS>
2026-03-08 22:24:34 -07:00
```
2026-03-07 01:14:10 -08:00
## NPM Scripts
| Command | Description |
| --- | --- |
2026-03-08 22:24:34 -07:00
| `npm run start` | Serve the static client locally and open `index.html`. |
2026-03-07 01:14:10 -08:00
| `npm run dev` | Alias of `npm run start`. |