Skip to content

lighthouse-buddies/BallUP

Repository files navigation

BallUP

The App is hosted at: https://ball-up-deployment.vercel.app/-79.4005188,43.6622882,12

An application designed to help basketball players and enthusiasts find courts near them. The app caters to both non-registered and registered users. While non-registered users can find courts near them, registered users enjoy the privilege of adding new courts, viewing their contributions, and adding comments and addresses.

About Page

About Page

Home Page

BallUP

Mobile View

Mobile view

Tech Stack

  • Next.js 13
  • React 18
  • Mapbox, Google Maps geocoding, and places APIs
  • PostgreSQL 10+
  • Prisma ORM

Installation

  1. Clone the repository

  2. Install dependencies by running npm install.

    If you encounter any errors related to peer dependencies, try using npm install --legacy-peer-deps instead.

  3. Create a .env.local file and add the following environment variables following the .env.example file

  4. Run the app using npm run dev

API Usage

This application uses the following APIs:

  • Mapbox API for displaying maps
  • Google Maps Geocoding API for converting addresses into geographic coordinates
  • Google Places API for details on points of interest and business locations

Ensure you have the respective API keys placed in the .env file.

Future Improvements

  • User profile enhancements
  • Additional social features such as friends and court recommendations
  • Ratings and reviews for each court

Dependencies

Node version v16.20.1 or higher is required.

npm version 8.19.4 or higher is required.

POSTGRESQL version 10.23 or higher is required.

Our application relies on the following dependencies:

{
  "@headlessui/react": "^1.7.7",
  "@heroicons/react": "^2.0.13",
  "@next/font": "13.1.1",
  "@prisma/client": "^4.8.1",
  "@reach/combobox": "^0.18.0",
  "@react-google-maps/api": "^2.17.1",
  "@tailwindcss/forms": "^0.5.3",
  "axios": "^1.2.2",
  "eslint": "8.31.0",
  "eslint-config-next": "13.1.1",
  "firebase": "^9.15.0",
  "heroicons": "^2.0.13",
  "mapbox-gl": "^2.12.0",
  "next": "13.1.1",
  "next-auth": "^4.18.8",
  "next-plausible": "^3.7.1",
  "prisma": "^4.8.1",
  "react": "^18.2.0",
  "react-dom": "^18.2.0",
  "react-map-gl": "^7.0.21",
  "use-places-autocomplete": "^4.0.0"
}

Dev Dependencies

{
  "autoprefixer": "^10.4.13",
  "postcss": "^8.4.21",
  "tailwindcss": "^3.2.4"
}

Contributors