Giter Club home page Giter Club logo

squad-management-tool's Introduction

Squad Management Tool

This is the code for the Squad Management Tool, a tool that guides users toward creating and configuring soccer teams. It also shows statistics about the current teams.


Features and specifications

Phase 1

  1. Implement Page Layout.
  2. Implement "My teams" section.
  3. Ability to Create/Edit and Remove a team.
  4. Ability to see what player was the most/less picked on.

Phase 2

  1. Ability to search for a player name and see the list of players who matched the criteria.
  2. Ability to add a player to a field position through drag n drop.
  3. Save must store the team's players into application state.

Phase 3

  1. Implement "Top 5" section to the dashboard.
  2. Ability to configure and display a given formation from the list (Soccer field must display the positions accordingly).
  3. Ability to see player information on hover (on soccer field)

Getting Started

To develop the application you will need npm or yarn installed in your computer.

  1. Clone the repository

    git clone https://github.com/felipemmendes/squad-management-tool.git
  2. Install NPM packages

    npm install

    or

    yarn
  3. Rename .env.example to .env and edit the variables with your own environment configuration (API url).

  4. Start the development API for fetching data.

    This project uses json-server and already have an .json with data for fetching in during development. To start the API, run:

    npx json-server db.json -p PORT

    Change PORT with port number, e.g., 3333. This will start the server on http://localhost:3333.

  5. Start the React server in development mode:

    npm run start

    or

    yarn start
  6. Access the application on http://localhost:3000.


Testing

To test the application run:

 npm run test

or

  yarn test

Deployment

Before deployment, make sure the fetching data params on src/store/players/slice.js match those of the API you will be using in production.

After this, you can deploy the application on any host service that supports a Node.js server. I suggest Vercel or Netlifyas they have free tiers for Personal use and are super easy to deploy and maintain. You can also use a VM, like the Droplets from Digital Ocean.

When deploying, make sure to set the environment variables for your production server (instructions for Vercel or Netlify). You will need to configure the redirects of your pages (instructions for Vercel or Netlify).

squad-management-tool's People

Contributors

felipemmendes avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.