Football League Standings Backend Server

This Node.js backend server is designed to manage football league standings, including creating, updating, retrieving, and deleting standings. It leverages MongoDB, a NoSQL database, to store competition data and interacts with the api.football-data.org API to fetch real-time competition standings.

Features

• Create Standings: Add new standings for different competitions by fetching data from the api.football-data.org.
• Retrieve Standings: Get the current standings of a specific competition by its code.
• Update Standings: Update the standings data for a competition.
• Delete Standings: Remove a competition's standings from the database.
• Error Handling: Proper error responses for non-existent competition codes or when requested data already exists.

Getting Started

Prerequisites

• Node.js installed on your machine.
• MongoDB setup locally or remotely.
• An API key from api.football-data.org.

Installation

1. Clone the repository:

   git clone https://github.com/<your-username>/football-league-standings-backend.git

2. Navigate into the project directory:

   cd football-league-standings-backend

3. Install dependencies:

   npm install
   

4. Create a .env file in the root directory and add your MongoDB connection string and api.football-data.org API key:

   MONGO_URI=<your_mongodb_connection_string>FOOTBALL_API_KEY=<your_api_football_data_org_key>

5. Start the server:

   npm start

API Endpoints

• POST /standings/:code: Create a new standing with the competition code.
• GET /standings/:code: Retrieve the standing by the competition code.
• PUT /standings/:code: Update the standing by the competition code.
• DELETE /standings/:code: Delete the standing by the competition code.

Mock API Endpoints

To conserve API request limits and avoid using real API calls to api.football-data.org, you can utilize mock data. These mock endpoints allow you to simulate operations without actual data modification or external API communication:

• POST /mock/standings/:code: Simulates the creation of a new standing using the specified competition code.
• GET /mock/standings/:code: Retrieves mock standing data for a given competition code.
• PUT /mock/standings/:code: Simulates the update of standings data for the specified competition code.
• DELETE /mock/standings/:code: Simulates the deletion of standings data for the specified competition code.

Running Tests

Ensure you have a separate test database and set NODE_ENV to test to avoid using the production or development database. Run tests using:

npm test

Deployment

The Football League Standings Backend Server has been deployed to Heroku and is accessible via the following base URL:

https://football-standings-backend-9c023af5d229.herokuapp.com/

Built With

• Node.js - The JavaScript runtime environment.
• MongoDB - The NoSQL database used.
• Express.js - The web application framework.

Contributing

• Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

License

• This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

• A special thanks to football-data.org for providing the comprehensive and up-to-date football data API. Their service has been instrumental in enabling us to fetch real-time competition standings and other football-related data, making our Football League Standings Backend Server much more dynamic and informative.