mirror of
https://github.com/rjNemo/football-summaries
synced 2026-06-06 02:16:43 +00:00
58 lines
1.5 KiB
Markdown
58 lines
1.5 KiB
Markdown
# Football summaries
|
|
|
|
See free video summaries of the latest football games.
|
|
|
|
## Getting Started
|
|
|
|
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
|
|
|
|
### Prerequisites
|
|
|
|
You need to have installed the following tools:
|
|
|
|
- Node.js
|
|
- Npm or Yarn
|
|
- React
|
|
|
|
### Installing
|
|
|
|
To run your own copy clone the repo and run
|
|
|
|
```shell
|
|
yarn install
|
|
```
|
|
|
|
And run it with
|
|
|
|
```
|
|
yarn start
|
|
```
|
|
|
|
End with an example of getting some data out of the system or using it for a little demo
|
|
|
|
## Deployment
|
|
|
|
Deploy this using [Netlify](https://netlify.com) or [Vercel](https://vercel.com).
|
|
|
|
## Built With
|
|
|
|
- [React](https://reactjs.org) - The web framework used
|
|
- [Scorebat API](https://www.scorebat.com) - Where the games come from
|
|
|
|
## Contributing
|
|
|
|
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
|
|
|
|
## Versioning
|
|
|
|
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/rjNemo/football-app/tags).
|
|
|
|
## Authors
|
|
|
|
- **Ruidy** - _Initial work_ - [Github](https://github.com/rjNemo)
|
|
|
|
See also the list of [contributors](https://github.com/rjNemo/football-app/contributors) who participated in this project.
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
|