# Football API App
This project is a web application that fetches and displays football data using the RapidAPI Football API. The app is built using modern JavaScript technologies and Vite for fast development and bundling.
## Features
- **Football Data**: Displays real-time football data including leagues, teams, players, and match results.
- **API Integration**: Fetches data from the Football API provided by RapidAPI.
- **Responsive Design**: The layout is designed to be responsive, ensuring a seamless user experience on mobile, tablet, and desktop devices.
## Project Structure
```bash
FootBall-Api/
├── public/ # Public folder for static assets (if needed)
├── src/ # Source folder for the main app code
│ ├── assets/ # Folder for images, fonts, etc.
│ ├── components/ # Reusable components for the app
│ ├── services/ # API calls and external services
│ ├── styles/ # CSS and styling related files
│ ├── App.js # Main React component
│ ├── index.js # Entry point for the app
│ └── ... # Additional source files
├── .eslintrc.cjs # ESLint configuration file for code quality
├── .gitignore # List of files and directories to ignore in Git
├── index.html # Main HTML file for the app
├── package-lock.json # Lock file for npm package versions
├── package.json # Project metadata and dependencies
├── vite.config.js # Vite configuration file for the build setup
└── README.md # Project documentation (this file)
- public/: Contains any static assets that do not need to be processed by Vite.
- src/: Contains all source code, including components, services for API calls, and styling.
- .eslintrc.cjs: ESLint configuration for enforcing coding standards.
- .gitignore: Specifies which files and directories Git should ignore.
- index.html: The HTML file that serves as the entry point for the app.
- package.json: Manages dependencies and scripts for the project.
- vite.config.js: Configuration file for Vite, a fast frontend build tool.
- Node.js installed on your machine.
- A RapidAPI account with access to the Football API.
-
Clone the repository:
git clone git@github.com:amar-jondhalekar/FootBall-Api.git
-
Navigate to the project directory:
cd FootBall-Api
-
Install dependencies:
npm install
-
Set up your API key from RapidAPI:
- Create an
.env
file in the root of the project. - Add your Football API key:
VITE_API_KEY=your_rapidapi_key_here
- Create an
-
Start the development server:
npm run dev
-
Open the app in your browser at
http://localhost:3000
.
- Use the app to browse football leagues, teams, and player data.
- View live match scores and results.
- Search for specific football-related data using the app’s interface.
To build the project for production, run:
npm run build
This will create an optimized bundle of the application in the dist/
directory, which you can deploy on any static hosting service.
Contributions are welcome! Fork this repository, make improvements, and submit a pull request.
This repository is maintained by Amar Jondhalekar.
Enjoy exploring the world of football with live data! ⚽