55 lines
1.6 KiB
Markdown
55 lines
1.6 KiB
Markdown
|
|
# TaroTime
|
|
|
|
A web-based esoteric correspondence app for tarot, astrology, calendars, symbols, and related systems.
|
|
|
|
[](https://nodejs.org/)
|
|
[](https://git-scm.com/)
|
|
[](https://code.glowers.club/goyimnose/tarot-deck)
|
|
|
|
## Features
|
|
|
|
- Correspondence explorer for multiple occult/esoteric systems.
|
|
- Tarot deck support served by the TaroTime API.
|
|
- Fast local static shell serving with `http-server`.
|
|
|
|
## Quick Start
|
|
|
|
1. Install Node.js: https://nodejs.org/en/download
|
|
2. Start the API and confirm its base URL and API key.
|
|
3. Clone this repository.
|
|
4. Install dependencies.
|
|
5. Start the client.
|
|
|
|
```powershell
|
|
git clone https://code.glowers.club/goyimnose/taroTime.git
|
|
Set-Location .\TaroTime
|
|
npm install
|
|
npm run start
|
|
```
|
|
|
|
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.
|
|
|
|
For local development with the current API configuration:
|
|
|
|
```powershell
|
|
API Base URL: http://localhost:3100
|
|
API Key: aaa
|
|
```
|
|
|
|
The current API also accepts `bbb` as a valid key.
|
|
|
|
|
|
|
|
## NPM Scripts
|
|
|
|
| Command | Description |
|
|
| --- | --- |
|
|
| `npm run start` | Serve the static client locally and open `index.html`. |
|
|
| `npm run dev` | Alias of `npm run start`. |
|
|
|
|
## Project Links
|
|
|
|
- Main app: https://code.glowers.club/goyimnose/tarotime
|
|
- Deck repo: https://code.glowers.club/goyimnose/tarot-deck
|