Skip to content

QUICKSTART.md

Latest commit

 

History

History
78 lines (55 loc) · 1.41 KB

QUICKSTART.md

File metadata and controls

78 lines (55 loc) · 1.41 KB
Raw

Quick Start

Get Jzero running in 5 minutes.

Prerequisites

  • Node.js 18+
  • Git

Install

git clone https://github.com/The-Decans-Project/Jzero.git
cd Jzero
npm install

Try It

Run an example:

node examples/basic-birth-chart.js

Start the API Server

npm run dev
# API running at http://localhost:3001

Test it:

curl http://localhost:3001/api/health

Start the Full Stack (API + Frontend)

npm run setup       # installs frontend dependencies too
npm run dev:full    # starts both servers

# Frontend: http://localhost:3000
# API:      http://localhost:3001

Use in Your Code

import { calculateBirthChart } from './astrology/core/calculator.js';

const chart = calculateBirthChart({
  year: 1994,
  month: 3,
  day: 1,
  hour: 14,
  minute: 28,
  timezone: -5,
  latitude: 40.7128,
  longitude: -74.0060
});

console.log('Sun:', chart.planets.Sun);
console.log('Ascendant:', chart.angles.ascendant);

Licensing Note

Jzero is MIT licensed. If you use Swiss Ephemeris for commercial purposes, its own license terms apply separately. See SWISS_EPHEMERIS_SETUP.md.

Next Steps