https://github.com/watson-clara/astrology-microservice-api

This microservice creates an API that will take in someone's birthday in the form {month}{day} in numbers and return their astrological sign.
https://github.com/watson-clara/astrology-microservice-api

api fastapi horoscope horoscope-api microservice uml-diagram

Last synced: 3 months ago
JSON representation

This microservice creates an API that will take in someone's birthday in the form {month}{day} in numbers and return their astrological sign.

• Host: GitHub
• URL: https://github.com/watson-clara/astrology-microservice-api
• Owner: watson-clara
• Created: 2022-07-27T04:18:09.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-07-28T03:09:43.000Z (almost 3 years ago)
• Last Synced: 2025-01-03T19:46:09.124Z (5 months ago)
• Topics: api, fastapi, horoscope, horoscope-api, microservice, uml-diagram
• Language: Python
• Homepage:
• Size: 12.7 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Microservice 

This microservice is apart of Assignment 7 for CS361. 

## What this project does:

This microservice creates an API that will take in someones birthday in the form {month}{day} in numbers and return their astrological sign. 

## How to use the microservice:

1. Open your terminal and clone this repository on your local hardrive. 

```

    git clone {link to repository ssh or https}

```

2. Navigate into the cloned repository. 

```

    cd Project-CS361

```

3. Visit the  [this page](https://fastapi.tiangolo.com/contributing/) to create and activate a virutal environment in which the microservice will run. 

```

    python -m venv env

    source ./env/bin/activate

```

4. Visit the  [this page](https://fastapi.tiangolo.com/tutorial/#install-fastapi) to install the FastAPI Python library.  

```

    pip install "fastapi[all]"

```

3. Run main.py

```

    python main.py 

```

## Using the API

Once you have run main.py you should see this in your terminal: 

![main.py running in terminal](/images/main.png)

Copy this into your browser:

![main.py running in terminal](/images/url.png)

This should appear:

![main.py running in terminal](/images/sign.png)

Type "/generate/{month}{day}" after the url inserting your month in number format. It should look like this:

![main.py running in terminal](/images/date.png)

If you have done everything right, the API should return your sign:

![main.py running in terminal](/images/return.png)

## UML Diagram

![UML](/images/uml.png)