[go: up one dir, main page]

Skip to content

This is a simple horoscope API built with Next.js, providing endpoints to fetch horoscopes based on zodiac sign and date/time

License

Notifications You must be signed in to change notification settings

thesushilsharma/Zodiac

Repository files navigation

Zodiac

This Next.js application allows you to explore your daily, weekly, monthly or more horoscope based on your chosen zodiac sign. It leverages Tailwind CSS for a clean and responsive user interface.

Features

  • Zodiac Sign Selection: Choose your zodiac sign from a dropdown menu.
  • Date Selection: Select the desired date for your horoscope (today, tomorrow, yesterday, weekly, or monthly).
  • Horoscope Display: View your personalized horoscope text in a dedicated section.
  • Clean and Responsive UI: Tailwind CSS ensures a beautiful and responsive layout across different devices.

Data Source

  • Fetches(web scraping) horoscope data from API

API Route

The application utilizes an API route (/api/horoscope) to fetch horoscope data from the external website. This route accepts query parameters for zodiacSign and timeFrame.

Endpoints

Get Horoscope for Today, Tomorrow, or Yesterday

  • Method: GET
    • http://localhost:3000/api/horoscope?zodiacSign=Cancer&period=today

    Replace Cancer with the desired zodiac sign and today with any timeframe you like.

Get Weekly or Monthly Horoscope

  • Method: GET
    • http://localhost:3000/api/horoscope?zodiacSign=Cancer&period=weekly

    Replace Cancer with the desired zodiac sign and weekly with any timeframe you like.

Get Specific Date Horoscope (In Progress)

  • Method: GET
    • http://localhost:3000/api/horoscope?zodiacSign=Cancer&period=YYYY-MM-DD

    Replace Cancer with the desired zodiac sign and YYYY-MM-DD with a date within the last year.

Get Previous or Current Year Horoscope (In Progress)

  • Method: GET

Usage

  • Visit the application in your browser.
  • Select your zodiac sign from the dropdown menu.
  • Choose your desired horoscope timeframe:
    • Today
    • Tomorrow
    • Yesterday
    • Weekly
    • Monthly
    • Specific Date (enter in YYYY-MM-DD format)
  • Click the "Get Horoscope" button.
  • Your personalized horoscope will be displayed below.

Prerequisites

  • VS Code or any Code editor
  • Node.js installed on your machine
  • npm package manager
  • To make API requests, you can use either the Postman or Thunder client extension in VS Code.

Installation

  1. Clone the repository:

    git clone https://github.com/thesushilsharma/Zodiac.git
  2. Install dependencies:

    • axios: Promise-based HTTP client for the browser and Node.js
    • cheerio: Fast, flexible & lean implementation of core jQuery designed specifically for the server
    • moment: Parse, validate, manipulate, and display dates and times in JavaScript
    cd Zodiac
    npm i
    
  3. Start the development server:

     npm run dev
    

This starts the development server and opens your app in the browser, typically at http://localhost:3000

Deployment:

You can deploy this API to a production server using a platform like Vercel, Netlify or any of your choice.

Contributing

Feel free to fork the repository and submit pull requests with your improvements or bug fixes. We welcome contributions from the community!

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

  • This project is for educational purposes only.

About

This is a simple horoscope API built with Next.js, providing endpoints to fetch horoscopes based on zodiac sign and date/time

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published