Skip to content

Seema111/team-generator-app

Repository files navigation

RANDOM TEAM GENERATOR APP

Getting Started

ABOUT THE PROJECT:

This documentation provides a comprehensive guide to the Random Team Generator App, including installation instructions, updates, API details, and the necessary data required for the app to function. The app is built using Next.js, Tailwind CSS, and React Icons, and it allows users to create random or skill-balanced teams from a list of participants. Features that are integrated: Generate completely random teams from a provided player list. Create balanced teams based on player skill levels (rated 1-5). Manage players and teams effectively. API endpoints for seamless integration with other applications.

Features:

  1. Generate completely random teams from a provided player list.

  2. Create balanced teams based on player skill levels (rated 1-5).

  3. Manage players and teams effectively.

  4. API endpoints for seamless integration with other applications.

  5. User-friendly interface with real-time updates.

Built With

This section should list any major frameworks/libraries Here are the list:

Prerequisites

First:

  • Node.js (v18+) & npm (v9) must be installed
  • Check your current node and npm version to make it compatible to go next steps further.

Installation

Below is the instruction to install the project.

  1. Clone the repo

    git clone https://github.com/Seema111/team-generator-app.git

  2. Install NPM packages

npm install

  1. Create a persona .env file OR update env.local to use personally

    MONGODB_URI="mongodbURL" <---MongoDB URI Link"--->

    NEXT_PUBLIC_API_BASE_URL=http://localhost:3000

  2. Run the Project using

    npm run dev

  3. Check your Database connection using API

    http://localhost:3000/api/checkDb

  4. Run the Build of project

    npm run build

Usage

For more details, please refer to the Documentation

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

About

A web application that can generate random teams from a list of players based on their skill levels.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages