Welcome to the API Football! This is a simple application for football lovers built on React, which uses Vite, ESLint, RTL, Jest, Vitest, SCSS, and TypeScript.
To install the API Football, please follow the steps below:
-
Ensure that you have Node.js at version 18 and npm installed on your computer. If you don't, you can download them from the official Node.js website https://nodejs.org/en/. I recommend NVM for the manage of node's version, you can download it from the official nvm repository https://github.com/nvm-sh/nvm.
-
Clone this repository to your local machine using the following command:
git clone git@github.com:ramonbs/api-football.git
- Navigate into the project directory:
cd api-football
- Install the required dependencies using npm:
npm install
or
pnpm install
This command will install all the required packages, including ESLint, RTL, and Jest.
To run the aplication, use the following command:
npm run dev
or
pnpm run dev
This will start a development server, which will allow you to view the application in your web browser. By default, the game will be available at http://localhost:5173.
To run the tests for the API Football, use the following command:
npm test
or
pnpm run test
This will run the Jest test suite, which will test the functionality of the application. For coverage, run the following code:
npm coverage
or
pnpm coverage