/sports-junction

Primary LanguageJavaScript

SPORTS JUNCTION

An awesome sports site to find all the football (soccer) leagues' information worldwide.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. Contact
  7. Acknowledgements

About The Project

There are many great codes available on GitHub, however, I tried to give it a shot with react js, react router, react context and material ui and created this project.

A list of commonly used resources that I find helpful are listed in the acknowledgements.

Features

  • Find all the Sports Leagues in the world
  • Infinite Scroll
  • Get details of any specific League

Built With

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  • npm 
    npm install npm@latest -g

Installation

  1. Clone the repo 
    git clone https://github.com/bmrabiulalam/sports-junction.git
  2. Go to the project folder 
    cd react-router-bmrabiulalam
  3. Install NPM packages 
    npm install

Usage

  1. Go to the project directory 
    cd react-router-bmrabiulalam
  2. Run the App 
    npm start

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Contact

Muhammad Rabiul Alam - @bm_rabiulalam - bmrabiulalam@gmail.com

Project Link: https://github.com/bmrabiulalam/sports-junction

Acknowledgements