https://github.com/nearhuscarl/football-site
https://github.com/nearhuscarl/football-site
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nearhuscarl/football-site
- Owner: NearHuscarl
- Created: 2019-03-23T12:33:36.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T17:18:51.000Z (almost 3 years ago)
- Last Synced: 2025-05-07T21:46:08.851Z (6 months ago)
- Language: JavaScript
- Size: 12.3 MB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [Football 365]
Latest football news, fixtures, results, statistics, standings
# Details
## Library and tool
- Front-end: react-redux
- Back-end: firestore cloud
## APIs used
- [Football data]
- [News API]
# Setup
## Download
* Install [nodejs] and yarn (optional, you can just use npm)
```bash
$ npm install -g yarn
```
* Open the terminal and type
```bash
$ git clone https://github.com/NearHuscarl/football-site
$ cd football-site
$ yarn install
```
## Setup firebase
- Get your firebase environment variables after creating a firebase project
- Fill in the `.env_development` file for development database
- Fill in the `.env_test` file for seperate testing database if needed
- Make sure git doesn't track those 2 files as they are your passwords to the database
## Setup service APIs:
- Get API keys (free) from [News API] and [Sportmonks]
- Fill in the `.api_keys` file
- In the root folder, run `./setup_heroku.sh`
## Build
```bash
$ yarn run build:dev
$ yarn run dev-server
```
## Test (Not available now)
```bash
$ yarn test
```
## Deploy on heroku
- Install heroku CLI on your computer
- Setup heroku
```bash
$ heroku login
$ cd
$ heroku create app-name
$ ./setup_heroku.sh # this is a bash script, use git bash to run on window
$ git remote -v # confirm the remote is setup
```
- Deploy on heroku
```bash
$ git push heroku master
```
[nodejs]: https://nodejs.org/en/download/
[Football 365]: https://football-365.herokuapp.com/
[News API]: https://newsapi.org/
[Sportmonks]: https://www.sportmonks.com
[Football data]: https://www.football-data.org/