README.md

astrology-api

Getting started

Prerequisites

• Nodejs >= 14 (also you can use docker)
• python (python is used for node-gyp to compile c++ swiss ephemeris library)

Setup

0. You need to install dependencies of node-gyp depending on your OS. Follow the instructions to install it depending on your OS https://github.com/nodejs/node-gyp#installation

1. Clone the repo

   git clone [email protected]:ryuphi/astrology-api.git

2. Install dependencies

   without Docker

   npm install

   npm start

   Also you can use npm run dev, this option run with nodemon to watch changes.

   with Docker (only install)

   docker-compose run api npm install

   with Docker (install & running)

   docker-compose up -d

   Running with docker use traefik as a proxy then you may use http://api.localhost instead of http://localhost:3000

Usage

Example: Get the horoscope for date 1993-08-06, time 16:50:00 and timezone -04:00 at Santiago, Chile (latitude -33.41167 and longitude -70.66647).

Fist, you need to transform the date & time to ISO8601, for this example 1993-08-06T16:50:00-04:00.

Second, you must escape the date and time when you make the request. This is because if the time zone is with a positive sign, for example +05:00, when sending it through the request, the url will take the + sign as a space and not as the + sign. For this example it would be 1993-08-06T16%3A50%3A00-04%3A00. See issue #10

If you don't want to escape the date and time, you can always send it to UTC 🙂

In UTC: 1993-08-06T20:50:00Z

Now you can send this...

Using cURL

# escaped
curl --request GET \
  --url 'http://localhost:3000/horoscope?time=1993-08-06T16%3A50%3A00-04%3A00&latitude=-33.41167&longitude=-70.66647'

# in utc
curl --request GET \
  --url 'http://localhost:3000/horoscope?time=1993-08-06T20:50:00Z&latitude=-33.41167&longitude=-70.66647'