https://github.com/stv-beep/f1-quotes-api

An API that provides numerous quotes said by famous Formula 1 drivers and personalities.
https://github.com/stv-beep/f1-quotes-api

api driver express f1-api formula1 formula1-api nodejs quotes rest typescript

Last synced: about 2 months ago
JSON representation

An API that provides numerous quotes said by famous Formula 1 drivers and personalities.

• Host: GitHub
• URL: https://github.com/stv-beep/f1-quotes-api
• Owner: stv-beep
• Created: 2022-08-26T21:12:04.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-23T16:03:53.000Z (4 months ago)
• Last Synced: 2024-08-24T17:42:59.407Z (4 months ago)
• Topics: api, driver, express, f1-api, formula1, formula1-api, nodejs, quotes, rest, typescript
• Language: TypeScript
• Homepage:
• Size: 460 KB
• Stars: 4
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


🏎 Formula 1 quotes API 🏎














##### An API showing several quotes said by famous Formula 1 drivers and Formula 1 personalities. It scraps all the quotes from certain webs

##### Very easy to use. GET ```/``` shows all the F1 drivers or personalities who have quotes saved in this API, and their code to access them. For example: Max Verstappen's quotes: ```/quotes/verstappen```. Please, realize that there are people with the same last name, so you will have to write the name-last name. Example: `/quotes/michael-schumacher` and `/quotes/mick-schumacher`

## Endpoints

#### GET list of F1 drivers or personalities with the available author endpoints

```

/

```

#### GET some iconic quotes of F1 drivers or personalities

```

/quotes

```

#### GET list of F1 drivers or personalities with their photos

```

/authors

```

#### GET F1 driver or personality with his photo

```

/authors/:authors_last_name

```

#### GET all saved quotes from a specific F1 driver

```

/quotes/:drivers_last_name

```

#### GET a specific quote from a specific F1 driver

```

/quotes/:drivers_last_name/:quote_id

```

#### GET 10 quotes in each page of a specific F1 driver

```

/quotes/:drivers_last_name/p/:page

```

## Development setup

`npm install`

`npm run tsc`

`npm run dev`

Open [http://localhost:3000](http://localhost:3000/) with your browser to see the API.

## Testing

`npm run test`

`npm run test:watch`

## Production setup

`npm start`

## Contributing

Please report any issue you find in the issues page. Pull requests are more than welcome.