Code Monkey home page Code Monkey logo

taylorswift_api's Introduction

Taylor Swift Relationships API

Overview

The Taylor Swift Relationships API is a Node.js and Express.js API that provides information about people Taylor Swift has dated in a chronological manner. The API includes their names, dates, and images.

Getting Started

Follow these instructions to set up the project locally on your machine.

Prerequisites

Make sure you have the following installed on your machine:

Installation

  1. Clone this repository to your local machine:
git clone https://github.com/your_username/TaylorSwiftRelationshipsAPI.git
  1. Navigate into the project directory:
cd TaylorSwiftRelationshipsAPI
  1. Install the project dependencies:
npm install

Configuration

Before running the server, you may need to configure some environment variables. Create a .env file in the root directory of the project and add the following:

# Example .env file
PORT=3000

Replace 3000 with your desired port number.

Running the Server

To start the Express server, run the following command:

npm start

The server should now be running locally on the port you specified in the .env file.

API Endpoints

Get All Relationships

  • URL: /relationships
  • Method: GET
  • Description: Retrieves all relationships Taylor Swift has been in.
  • Response:
    • Status: 200 OK
    • Body: Array of relationship objects containing names, dates, and images.

Get Relationship by ID

  • URL: /relationships/:id
  • Method: GET
  • Description: Retrieves a specific relationship by its ID.
  • Parameters:
    • id: The unique identifier of the relationship.
  • Response:
    • Status: 200 OK
    • Body: Object containing the details of the relationship.
    • Status: 404 Not Found if the relationship with the specified ID does not exist.

Contributing

Contributions are welcome! If you have any suggestions, feature requests, or bug reports, please open an issue or submit a pull request.

License

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

taylorswift_api's People

Contributors

anxbt avatar gamingwithnickyt avatar

Stargazers

Manish Dusa avatar

Watchers

 avatar

taylorswift_api's Issues

good first issue

List all the exes of Taylor Swift and add url to the images.
#goodfirstissue
#enhancement
#beignerfriendly

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.