bgs89 / premier-football

---

Non-League Football App

Table of Contents

• Introduction
• Features
• Technologies
• Installation
• Usage
• API

Introduction

Welcome to the PremierFootball App! This application is designed to provide football fans of teams in the Isthmian Premier League with easy access to non-league football fixtures, results, news, and league tables. Whether you're a dedicated supporter or just curious about non-league football, this app has something for everyone.

Features

• View upcoming fixtures for the current week.
• Browse all fixtures and their results.
• Filter fixtures and results by your favorite team.
• Stay updated with the latest football news.
• Access the full up to date league table.

Technologies

This project is built using the following technologies:

• React
• Bootstrap
• Football Web Pages API

Installation

1. Clone the repository to your local machine using the following command:

   git clone https://github.com/BGS89/premier-football.git

2. Navigate to the project directory:

   cd nonleaguefootball

3. Install the required dependencies:

   npm install

4. Create a .env file in the project root directory to store your API key. You can obtain an API key from the Football Web Pages API:

   VITE_SOME_KEY=your_api_key
   

5. Start the development server:

   npm run dev

Usage

1. Upon starting the app, you will see a homepage with several navigation options.
2. Use the "Fixtures" option to browse all fixtures and results.
3. Filter fixtures by your favorite team using the "Filter by Team" feature.
4. Stay informed with the latest football news by clicking on "News."
5. Access the full league table by clicking on "Table."

API

This project uses the Football Web Pages API to fetch football-related data. You can find more information and obtain an API key from their official website.

---