|
2 | 2 | <h1>🏎 Formula 1 quotes API 🏎</h1> |
3 | 3 |
|
4 | 4 | <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"/> |
6 | 6 | <img src="https://img.shields.io/badge/npm-%3E%3D8.5.0-blue.svg"/> |
7 | 7 | <img src="https://img.shields.io/badge/node-%3E%3D16.14.2-blue.svg"/> |
8 | 8 | </p> |
9 | 9 | </div> |
10 | 10 |
|
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 |
12 | 12 |
|
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` |
14 | 14 |
|
15 | 15 | ## Endpoints |
| 16 | + |
16 | 17 | #### GET list of F1 drivers or personalities with the available author endpoints |
| 18 | + |
17 | 19 | ``` |
18 | 20 | / |
19 | 21 | ``` |
20 | 22 |
|
21 | 23 | #### GET 10 interesting quotes of F1 drivers or personalities |
| 24 | + |
22 | 25 | ``` |
23 | 26 | /quotes |
24 | 27 | ``` |
25 | 28 |
|
26 | 29 | #### GET list of F1 drivers or personalities with their photos |
| 30 | + |
27 | 31 | ``` |
28 | 32 | /authors |
29 | 33 | ``` |
30 | 34 |
|
31 | 35 | #### GET F1 driver or personality with his photo |
| 36 | + |
32 | 37 | ``` |
33 | 38 | /authors/:authors_last_name |
34 | 39 | ``` |
35 | 40 |
|
36 | 41 | #### GET all saved quotes from a specific F1 driver |
| 42 | + |
37 | 43 | ``` |
38 | 44 | /quotes/:drivers_last_name |
39 | 45 | ``` |
40 | 46 |
|
41 | | -#### GET a specific quote from a specific F1 driver |
| 47 | +#### GET a specific quote from a specific F1 driver |
| 48 | + |
42 | 49 | ``` |
43 | 50 | /quotes/:drivers_last_name/:quote_id |
44 | 51 | ``` |
45 | 52 |
|
46 | 53 | #### GET 10 quotes in each page of a specific F1 driver |
| 54 | + |
47 | 55 | ``` |
48 | 56 | /quotes/:drivers_last_name/p/:page |
49 | 57 | ``` |
50 | 58 |
|
51 | 59 | ## Development setup |
| 60 | + |
52 | 61 | `npm install` |
53 | 62 |
|
54 | 63 | `npm run tsc` |
|
58 | 67 | Open [http://localhost:3000](http://localhost:3000/) with your browser to see the API. |
59 | 68 |
|
60 | 69 | ## Testing |
| 70 | + |
61 | 71 | `npm run test` |
62 | 72 |
|
63 | 73 | `npm run test:watch` |
64 | 74 |
|
65 | 75 | ## Production setup |
| 76 | + |
66 | 77 | `npm start` |
67 | 78 |
|
68 | 79 | ## Contributing |
| 80 | + |
69 | 81 | Please report any issue you find in the issues page. Pull requests are more than welcome. |
0 commit comments