Skip to content

HoopIntel is a prototype application that allows users to search for NBA players by name and view detailed information about them using the balldontlie API

Notifications You must be signed in to change notification settings

noah-delacruz/HoopIntel

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HoopIntel

HoopIntel is a prototype application that allows users to search for NBA players by name and view detailed information about them using the balldontlie API (https://www.balldontlie.io/). This project demonstrates a unit-tested full-stack implementation using React for the frontend and Express for the backend, styled with Material UI.


📋 Features

  • Search for NBA players by name.
  • View up to 10 search results at a time with pagination.
  • Display player details such as height, weight, draft year, and college.
  • Mark/unmark players as favorites, with changes persisted using local storage.

🛠️ Tech Stack

Backend

  • Express - Backend framework.
  • balldontlie API - External API for NBA player data.
  • Jest + Supertest - For backend unit testing.

Frontend

  • React - Frontend framework.
  • Material UI - Styling.
  • Vitest + React Testing Library - For frontend unit testing.

Deployment

  • Backend - Deployed on Render.
  • Frontend - Deployed on Vercel.

🚀 Setup and Installation

Prerequisites

  • Node.js installed.
  • An API key from the balldontlie API.

Steps to Run Locally

  1. Clone the repository:

    git clone https://github.com/noah-delacruz/HoopIntel/
  2. Backend Setup:

    • Navigate to the backend directory:
      cd backend
    • Install dependencies:
      npm install
    • Create a .env file and add your balldontlie API key:
      API_KEY=your_api_key_here
    • Start the backend server:
      npm run start
  3. Frontend Setup:

    • Open a new terminal and navigate to the frontend directory:
      cd frontend
    • Install dependencies:
      npm install
    • Start the development server:
      npm run dev

🧪 Testing

Backend

  • Run backend tests with:
    npm run test

Frontend

  • Run frontend tests with:
    npm run test

📈 Future Improvements

  • Persist user choices using a backend database instead of local storage.
  • Implement authentication for user accounts.

📝 License

This project is licensed under the MIT License.


Feel free to reach out if you have any questions or suggestions for improvement!

About

HoopIntel is a prototype application that allows users to search for NBA players by name and view detailed information about them using the balldontlie API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published