Skip to content

Latest commit

 

History

History
88 lines (55 loc) · 2.38 KB

README.md

File metadata and controls

88 lines (55 loc) · 2.38 KB

offpitch


Status

About

offpitch is a webplatform for managing football tournaments. Here users can host tournaments and manage the teams, matches, table, points ...etc. And for the teams they can create a club page, add players and then they can register for the tournaments. Also the tournament host can sell the ticket to the tournament through this platform

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Requirements you need to run the software and how to get them.

  1. Git
  2. NodeJs
  3. yarn

Installation

A step by step series of examples that tell you how to get a development env running.

Clone this repository to your local system.

git clone https://github.com/shamilkotta/offpitch_Frontend.git

Then go to this project directory by running command cd offpitch_Frontend

Firstly install the required packages

yarn install --frozen-lockfile

Then start the dev server by executing

yarn start

Now you can navigate to browser in url http://localhost:3000 (by default) to see the output.

Coding style tests

Check if any files need to be formatted, if the check fails that means some files needed to be formatted or have to do some fixes.

eslint

yarn run lint

prettier

yarn run format:check

To format all required code files

yarn run lint:fix
yarn run format

Contributing

Read contributing instructions and guidlines from here.

Built Using

Author

This project follows the all-contributors specification. Contributions of any kind are welcome!