Skip to content

Latest commit

 

History

History
102 lines (75 loc) · 2.37 KB

File metadata and controls

102 lines (75 loc) · 2.37 KB


Logo

Goodminton

Welcome to Goodminton your go-to destination for hassle-free badminton experiences! Easily book courts at top venues, participate in thrilling tournaments, and connect with a vibrant badminton community. Enjoy the convenience of anytime, anywhere access to elevate your game. Goodminton where convenience meets competition for the ultimate badminton bliss!

Getting Started

To get a local copy up and running follow these steps.

Prerequisites

  • npm
    npm install npm@latest -g
  • MongoDB
- Follow the instructions on the MongoDB website for installing the community edition

Installation

  1. Start up the MongoDB server on port 27017
  2. Clone the repo
    git clone https://github.com/JasonQiu21/goodminton.git
  3. Install NPM packages
    npm install
  4. Seed some sample data into the database.
    npm run seed

(back to top)

Usage

Register an account here: http://localhost:3000/register
Or sign-in with some of the sample accounts:
Admin username: jqiu21@stevens.edu
Admin password: password1
(admin accounts can create events)

Normal username: phill@stevens.edu
Normal password: password12

All features can be accessed through the navigation bar at the top.

Some sample features that users can do:
You can reserve for events (practices/tournaments) if you are signed in
View/create/edit prfiles

Some sample features that admins can do:
Create/start events (create brackets for tournament, we have round robin and swiss styles)
Inputting scores for tournaments

For more examples, please refer to the Documentation

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)