moved to API
This commit is contained in:
27
README.md
27
README.md
@@ -10,16 +10,16 @@ A web-based esoteric correspondence app for tarot, astrology, calendars, symbols
|
||||
## Features
|
||||
|
||||
- Correspondence explorer for multiple occult/esoteric systems.
|
||||
- Tarot deck support via a generated deck registry.
|
||||
- Pluggable deck structure using per-deck `deck.json` manifests.
|
||||
- Fast local static serving with `http-server`.
|
||||
- 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. Clone this repository.
|
||||
3. Install dependencies.
|
||||
4. Start the app.
|
||||
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
|
||||
@@ -28,7 +28,16 @@ npm install
|
||||
npm run start
|
||||
```
|
||||
|
||||
The app opens in your browser (typically at `http://127.0.0.1:8080`).
|
||||
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.
|
||||
|
||||
|
||||
|
||||
@@ -36,10 +45,8 @@ The app opens in your browser (typically at `http://127.0.0.1:8080`).
|
||||
|
||||
| Command | Description |
|
||||
| --- | --- |
|
||||
| `npm run start` | Generate deck registry, then serve the app locally and open `index.html`. |
|
||||
| `npm run start` | Serve the static client locally and open `index.html`. |
|
||||
| `npm run dev` | Alias of `npm run start`. |
|
||||
| `npm run generate:decks` | Rebuild `asset/tarot deck/decks.json`. |
|
||||
| `npm run validate:decks` | Strict validation only (no write), exits on manifest/file problems. |
|
||||
|
||||
## Project Links
|
||||
|
||||
|
||||
Reference in New Issue
Block a user