A full-stack web platform that enables users to manage football tournaments, including hosting, team and match management, and ticket sales. I incorporated various technologies, such as Redux, Tailwind, Razorpay, and Cloudinary, to enhance the platform's functionality and improve the user experience. I designed OffPitch to support multiple tournament formats, including league, knockout, double league, and group stage-knockout, to offer users maximum flexibility.
Overall, OffPitch is a powerful and user-friendly platform that makes managing football tournaments simple and efficient, providing users with the flexibility and functionality they need to create successful and enjoyable events.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Requirements you need to run the software and how to get them.
- Git
- NodeJs
- yarn
- Mongodb
- Oauth tokens for your email to setup nodemailer
- Razorpay account
- Cloudinary account. ...etc
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_Backend.git
Then go to this project directory by running command cd offpitch_Backend
Firstly install the required packages
yarn install --frozen-lockfile
Then you've to setup env file.
Create a .env file and paste the keys inthe .sample.env and add your values.
Then start the dev server by executing
yarn run dev
Now you can navigate to browser in url http://localhost:5000 (by default) to see the output.
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
Read contributing instructions and guidlines from here.
This project follows the all-contributors specification. Contributions of any kind are welcome!