Skip to content

Commit dbeb070

Browse files
committed
version and dependencies update
1 parent 87caa42 commit dbeb070

File tree

3 files changed

+164
-369
lines changed

3 files changed

+164
-369
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,53 +2,62 @@
22
<h1>🏎 Formula 1 quotes API 🏎</h1>
33

44
<p>
5-
<img alt="Version" src="https://img.shields.io/badge/version-0.7.1-greenyellow.svg"/>
5+
<img alt="Version" src="https://img.shields.io/badge/version-0.7.3-greenyellow.svg"/>
66
<img src="https://img.shields.io/badge/npm-%3E%3D8.5.0-blue.svg"/>
77
<img src="https://img.shields.io/badge/node-%3E%3D16.14.2-blue.svg"/>
88
</p>
99
</div>
1010

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

13-
##### 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`.
13+
##### 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`
1414

1515
## Endpoints
16+
1617
#### GET list of F1 drivers or personalities with the available author endpoints
18+
1719
```
1820
/
1921
```
2022

2123
#### GET 10 interesting quotes of F1 drivers or personalities
24+
2225
```
2326
/quotes
2427
```
2528

2629
#### GET list of F1 drivers or personalities with their photos
30+
2731
```
2832
/authors
2933
```
3034

3135
#### GET F1 driver or personality with his photo
36+
3237
```
3338
/authors/:authors_last_name
3439
```
3540

3641
#### GET all saved quotes from a specific F1 driver
42+
3743
```
3844
/quotes/:drivers_last_name
3945
```
4046

41-
#### GET a specific quote from a specific F1 driver
47+
#### GET a specific quote from a specific F1 driver
48+
4249
```
4350
/quotes/:drivers_last_name/:quote_id
4451
```
4552

4653
#### GET 10 quotes in each page of a specific F1 driver
54+
4755
```
4856
/quotes/:drivers_last_name/p/:page
4957
```
5058

5159
## Development setup
60+
5261
`npm install`
5362

5463
`npm run tsc`
@@ -58,12 +67,15 @@
5867
Open [http://localhost:3000](http://localhost:3000/) with your browser to see the API.
5968

6069
## Testing
70+
6171
`npm run test`
6272

6373
`npm run test:watch`
6474

6575
## Production setup
76+
6677
`npm start`
6778

6879
## Contributing
80+
6981
Please report any issue you find in the issues page. Pull requests are more than welcome.

0 commit comments

Comments
 (0)