Skip to content
This repository has been archived by the owner on Nov 5, 2022. It is now read-only.

Latest commit

 

History

History
213 lines (159 loc) · 9.85 KB

README.md

File metadata and controls

213 lines (159 loc) · 9.85 KB
Raw

Come On You _____ !

Come On You __ !

  • The football team randomizer and score keeping web app

Frontend GitHub

https://github.com/nosvalds/come-on-you-team

Backend/API GitHub

https://github.com/nosvalds/come-on-you-team-db

Version History

v1.0

Background

The initial project brief was to create an app that takes 10 player names and randomly sorts them into two 5-a-side football teams. I set out to create a web app that met these base requirements, but looked ahead to future functionality that I wanted to add.

Plan

I spent most of the first morning putting the ideas that had popped into my head over the weekend into notes and on paper in a wireframe. I wanted the players to be laid out on the screen with a football pitch background as I thought this would be a nice visual representation and would potentially give me the option of adding "formations" to further releases.

As I was planning I split out the Minimum Viable Product (MVP) and "stretch" feature ideas. While I was designing the MVP, I tried to keep and eye out for places in the design and code that I could make things easily changeable and expandable for the future features.

As for technologies I decided to start with a React/Redux web application. I understood this was likely overkill for the MVP, but with my stretch goals would become more neccessary for the interactivity that I desired. Also looking through previous students project examples I saw they were able to achieve good functionality with these technologies. I also penciled in the thought of creating a back end Laravel API to keep track of match scores over time.

You can view my full design notes here.

v2.0

Features

  • Pick # of players per side
  • Ability to change team names
  • Update game flow due to above changes
  • Start Over and Shuffle buttons
  • Refactor Offense/Defense/Goal components to be one "Pitch Section" re-useable component
  • Make Mobile-friendly and responsive

v2.1

Fix/Update

  • Fix game flow after user feedback
    • Don't display "Teams Filled, Game On" until team names are filled out by the user
    • Display direction to fill out team names when team names are in edit mode

v3.0

Planned Features/Work

  • Back-end Laravel API to save match history
  • Front-end updates to support GET/POST/PUT/DELETE requests for saving and displaying match history
    • React/JSX component to display match history from test data in state
    • React Router set up for navigation between match play and history
    • Axios set up
    • GET request for full match history,
    • DELETE request to remove a match from the history table
    • React/JSX component to record score
    • POST request to save a completed match to the DB
      • [_] send user to history instead of Play after saving match
    • [_] PUT request to "save" a match mid-match
      • Abandoning this for now due to lack of time. Since the backend doesn't keep track of players yet it wouldn't be great functionality to have.
  • Deployment
    • Laravel API Back-end on Heroku
  • Add instructions section on app
  • Have API sort matches newest first

v3.1

Planned work

  • Update documentation for how to run this project
  • Some user experience improvements
    • Set up local storage, so that user does not lose their place on browser refresh. Long term data is still stored in the API backend.
    • Lifted the showInstructions state to the app level so that could persist on refresh
  • Refactor/clean up code, fix/add comments

Lessons Learned

  • Planning is critical and thinking ahead for future functionality/releases is important in the design. This can make starting out and getting an MVP running more work that you expect, but will be worth it in the end.
    • E.g. I'm storing the players names in an array of objects like { name: "Name" }, which represent each player, rather than just an array of player name strings. This will allow me to add more information about the players in the future (age, height, skill, etc.)
  • It's okay to scrap design ideas or architecture you originally thought was going to be neccessary.
  • Getting feedback from someone not familiar with the app is really useful. I had my girlfriend play and she told me that it wasn't clear on mobile when you should be editing the team names. This pushed me to release v2.1 that clears this up.

v3.2

ChangeLog

  • Fixed CORS issues
  • Final release for Developme_ technical challenge deadline

v3.3

ChangeLog

  • Remove distracting spinning ball animation
  • Add short description of the application in the header
  • Make the instructions more readable
  • Show "Match History" by default

Running this Project Yourself:

  1. Clone the git repository to your local machine by running the following commands in your terminal. Or copy the project folder from google drive to your local machine.
git clone [email protected]:nosvalds/come-on-you-team.git {project-directory}
  1. In your terminal cd into the project directory and run the below npm command to install neccessary dependency packages
cd {project-directory}
npm install
  1. In your terminal run the local development server provided by create-react-app to view on your local machine
npm start
  1. You should see a message like this when the development server is up and running.
Compiled successfully!

You can now view come-on-you-team in the browser.

  Local:            http://localhost:3000/come-on-you-team
  On Your Network:  http://192.168.0.96:3000/come-on-you-team
  1. Navigate to the "Local" URL from above in your favourite browser

Directory Structure

/src

Source directory where all changes are made.

  • /App/ - contains the main React App. Header/Footer, different components and the routing.
  • /axios/ - contains axios set up to make AJAX requests to the Laravel API. Endpoints for the API are defined here
  • /components/ - contains all the React components that make up the App
  • /css/ - CSS files
  • /data/ - contains the Redux set up to handle state management
  • /img/ - images
  • index.js - top level of the React application. Contains Redux set up and CSS import

Deploying to gitHub Pages

If you'd like to deploy this page from your own gitHub repository you can follow the below steps:

  1. Fork the Repo
  2. Update your package.json file with this line for your new repo:
"homepage": "https://{github-username}.github.io/{repo-name}/"
  1. Run the below command
npm run deploy

The above command uses the gh-pages package to deploy to gitHub pages. The script definition lives in package.json and runs:

react-scripts build
gh-pages -d build

Deploying to Kualo

  • It's weird. deploy.js doesn't work even though it says it does
  • I was able to clone the repo copy over the build directory, commit, and then push. The git setup is kinda screwy.
  • Maybe I can just write a script to do that work instead of using gh-pages plugin

Create React App documentation

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify