https://github.com/deveshsangwan/cricketscoreapi
Welcome to the Cricket Score API! This project is designed to provide real-time cricket scores using TypeScript and npm. It uses technologies like Cheerio for web scraping, Prisma for accessing MongoDB, Express-jwt for authentication, and Chai and Mocha for testing.
https://github.com/deveshsangwan/cricketscoreapi
api cheerio cricket cricket-api cricket-data cricket-score cricket-stats docker express jwt-authentication livescore mocha-chai mongodb nodejs prisma realtime-data rest-api sports-data typescript webscraping
Last synced: 7 days ago
JSON representation
Welcome to the Cricket Score API! This project is designed to provide real-time cricket scores using TypeScript and npm. It uses technologies like Cheerio for web scraping, Prisma for accessing MongoDB, Express-jwt for authentication, and Chai and Mocha for testing.
- Host: GitHub
- URL: https://github.com/deveshsangwan/cricketscoreapi
- Owner: deveshsangwan
- Created: 2023-02-25T16:17:40.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-10-06T18:13:27.000Z (8 days ago)
- Last Synced: 2025-10-06T20:24:25.396Z (8 days ago)
- Topics: api, cheerio, cricket, cricket-api, cricket-data, cricket-score, cricket-stats, docker, express, jwt-authentication, livescore, mocha-chai, mongodb, nodejs, prisma, realtime-data, rest-api, sports-data, typescript, webscraping
- Language: TypeScript
- Homepage: https://cricscore.deveshsangwan.com
- Size: 1.05 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🏏 Cricket Score Monorepo
Welcome to the Cricket Score monorepo! This repository contains the frontend and backend for a real-time cricket score application.
## 🚀 Projects
This monorepo contains the following projects:
- **`apps/cricket-score-frontend`**: A [Next.js](https://nextjs.org/) frontend that displays live cricket scores and statistics. See the [frontend README](./apps/cricket-score-frontend/README.md) for more details.
- **`apps/cricketscoreapi`**: A [TypeScript](https://www.typescriptlang.org/) backend exposing a **tRPC API** (via Express) for cricket data. See the [backend README](./apps/cricketscoreapi/README.md) for more details.
- **`packages/shared-types`**: Shared TypeScript types consumed by both the backend and frontend.
## 🛠️ Technologies Used
This monorepo uses [pnpm](https://pnpm.io/) for workspace management.
### Frontend
- [Next.js](https://nextjs.org/)
- [React](https://reactjs.org/)
- [TypeScript](https://www.typescriptlang.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Clerk](https://clerk.com/)
### Backend
- [TypeScript](https://www.typescriptlang.org/)
- [Express.js](https://expressjs.com/)
- [tRPC](https://trpc.io/)
- [Prisma](https://www.prisma.io/)
- [MongoDB](https://www.mongodb.com/)
- [Cheerio](https://cheerio.js.org/)
- [Docker](https://www.docker.com/)
## 🚀 Getting Started
To get started with this monorepo, you'll need to have [pnpm](https://pnpm.io/) installed. Then, you can install the dependencies from the root of the repository:
```bash
pnpm install
```
This will install the dependencies for all the projects in the monorepo.
### Running the projects
You can run the frontend and backend projects separately using the following commands:
```bash
# Run both frontend and backend (concurrently)
pnpm dev
# Or run them separately
pnpm frontend:dev
pnpm backend:dev
```
Ports:
- Frontend: `http://localhost:3000`
- Backend tRPC endpoint: `http://localhost:3001/trpc`
## 🔄 Real-time Flow (Sequence Diagram)
```mermaid
sequenceDiagram
participant UI as Match Page
participant Hook as useOptimizedRealTimeMatchStats
participant TRPC as tRPC Client (splitLink)
participant Sub as httpSubscriptionLink (SSE)
participant API as cricketscoreapi Router
UI->>Hook: init(matchId)
Hook->>TRPC: subscribeMatchStatsById(matchId)
TRPC-->>Sub: route op: type=subscription
Sub->>API: SSE connect with Authorization
API-->>Sub: initial MatchStats
Sub-->>Hook: data event
Hook-->>UI: set state/render
loop every 30s until abort
API-->>Sub: updated MatchStats
Sub-->>Hook: data event
Hook-->>UI: update state
end
UI->>Hook: unmount/abort
Hook->>Sub: close
Sub->>API: abort
```
## 📜 License
Each project in this monorepo has its own license. Please refer to the `LICENSE.md` file in each project's directory for more information.