Skip to content

Miki0035/sportz-frontend

Repository files navigation

Sportz

sportz

React TypeScript Vite WebSocket TailwindCSS

  1. 👋 Welcome
  2. ⚙️ Tech Stack
  3. 🔋 Features
  4. 🌐 Website URL
  5. 🤸 Quick Start
  6. ⚠️ Backend Required

Thanks for checking out this sportz app. This app is the frontend part of a complete full stack web socket application with an Sportz Backend backend. This app is from one of JavaScript Mastery Youtube channel JavaScript Mastery (Shout out to Adrian and JSMastery team😃 ) highly recommend if you want to upgrade your skills as a full stack developer. Check it out 😮 and let me know what you think.

👉 Live Sport Updates : displaying real-time sport events.

Follow this steps to setup the project locally on your machine.

Prerequsites

Make sure you have the following installed on your machine

Cloning the Repository

git clone https://github.com/Miki0035/sportz-frontend

cd sportz-frontend

Installing dependencies

Run the following command to install all dependencies

npm install

Environment variables

In the root of your project

- create '.env' file
- add variables similar to the ones located in .env.example

Running the Project

Finally run

npm run dev

In your browser go to 'localhost:3000' 👍

This frontend depends on a backend service for full functionality (e.g., API WebSocket connections).
Please clone and run the backend from:

👉 Sportz Backend

Without the backend, some features may not work as expected.

About

Sportz - A real-time sports dashboard featuring live WebSocket match updates, commentary feeds, and a strict neo-brutalism design system.

Topics

Resources

Stars

Watchers

Forks

Contributors