/shinpan

A tournament management application

Primary LanguageJavaScriptMIT LicenseMIT

shinpan

A tournament management application

License: MIT

Table of Contents

  1. Description
  2. Installation Instructions
  3. Usage
  4. Contribution Guidelines
  5. License
  6. Questions

Description

This is a MERN web application that uses MongoDB and Apollo Server to bring in participants of a tournament and to seed the brackets.

Installation Instructions

  1. if using SSH, use the following command: git clone git@github.com:KatsuMatsushita/shinpan.git
  2. if using the GitHub CLI, use the following command: gh repo clone KatsuMatsushita/shinpan

Once copied, run "npm install" to install the client and server dependencies

Usage

  1. On the homepage, click on Login/Sign Up to either log in with a created account, or sign up a new account.
  2. graphQL queries can be sent to 3001/gql
  3. the following mutations are currently implemented: addPlayer (which adds a player to a tournament), seedBracket (which seeds a bracket in a tournament from its players)

Contribution Guidelines

  1. Clone the Main branch of the repository from GitHub
  2. Create a Branch and name it using the format: "feature_contributor"
  3. Create a pull request
  4. Send an email to the address listed in the Questions section, containing a summary of the contribution

License

MIT https://opensource.org/licenses/MIT A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.

Questions

GitHub name: KatsuMatsushita

GitHub Profile

To contact me, drop an email to: katsu.matsushita@gmail.com