https://github.com/aleexcif/github-repository-stats-api
This API allows users to track and retrieve statistics for specific GitHub repositories. It will fetch and store data like the number of stars, forks, and open issues, allowing periodic updates to keep stats current. This project will demonstrate CRUD operations, external API integration, and data fetching automation.
https://github.com/aleexcif/github-repository-stats-api
api express github nodejs typescript
Last synced: 2 months ago
JSON representation
This API allows users to track and retrieve statistics for specific GitHub repositories. It will fetch and store data like the number of stars, forks, and open issues, allowing periodic updates to keep stats current. This project will demonstrate CRUD operations, external API integration, and data fetching automation.
- Host: GitHub
- URL: https://github.com/aleexcif/github-repository-stats-api
- Owner: aleexcif
- License: mit
- Created: 2024-11-12T06:34:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-12T00:42:20.000Z (about 1 year ago)
- Last Synced: 2025-05-12T01:30:22.536Z (about 1 year ago)
- Topics: api, express, github, nodejs, typescript
- Language: TypeScript
- Homepage: https://aleexcif.dev
- Size: 48.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Repository Stats API
A RESTful API built with `TypeScript`, `Node.js`, and `SQLite` to track and retrieve GitHub repository statistics such as stars, forks, and open issues.
## Features
- Track GitHub repositories by owner and name
- Retrieve statistics (stars, forks, open issues) for each tracked repository
- Update repository stats periodically with `node-cron`
- Endpoints for adding, retrieving, and deleting tracked repositories
## Prerequisites
- **`Node.js`** v14 or higher
- **GitHub Personal Access Token** (optional, if you need higher API rate limits)
## Installation
1. **Clone the Repository**:
```zsh
git clone https://github.com/aleexcif/github-repository-stats-api.git
cd github-repository-stats-api
```
2. **Install Dependencies**:
```zsh
npm install
```
3. **Set Up Environment Variables**:
- Create a .env file to store environment variables (optional).
```
GITHUB_TOKEN=your_github_personal_access_token`
```
4. **Start the Server**:
- In development with auto-restart:
```zsh
npx ts-node-dev --respawn src/app.ts
```
- In production (compile TypeScript and run `Node.js`):
```zsh
npx tsc
node dist/app.js
```
## Usage
### Endpoints
1. **Add a Repository to Track**:
- Method: `POST`
- URL: `http://localhost:3000/api/repositories`
- curl Command:
```zsh
curl -X POST http://localhost:3000/api/repositories \
-H "Content-Type: application/json" \
-d '{"owner": "ownerName", "name": "repositoryName"}'
```
- Example Response:
```json
{
"message": "Repository added successfully",
"stats": {
"stars": 123,
"forks": 45,
"openIssues": 10,
"lastUpdated": "2024-11-12T08:09:18.417Z"
}
}
```
2. **Retrieve All Tracked Repositories**:
- Method: `GET`
- URL: `http://localhost:3000/api/repositories`
- curl Command:
```zsh
curl -X POST http://localhost:3000/api/repositories
```
- Example Response:
```json
[
{
"id": 1,
"name": "repositoryName",
"owner": "ownerName",
"stars": 123,
"forks": 45,
"openIssues": 10,
"lastUpdated": "2024-11-12T08:09:18.417Z"
},
...
]
```
3. **Retrieve Stats for a Specific Repository**
- Method: `GET`
- URL: `http://localhost:3000/api/repositories/{id}`
- curl Command:
```zsh
curl -X GET http://localhost:3000/api/repositories/1
```
- Example Response:
```json
{
"id": 1,
"name": "repositoryName",
"owner": "ownerName",
"stars": 123,
"forks": 45,
"openIssues": 10,
"lastUpdated": "2024-11-12T08:09:18.417Z"
}
```
4. **Delete a Repository**
- Method: `DELETE`
- URL: `http://localhost:3000/api/repositories/{id}`
- curl Command:
```zsh
curl -X DELETE http://localhost:3000/api/repositories/1
```
- Example Response:
```json
{
"message": "Repository deleted successfully"
}
```
---
> [!NOTE]
> This should provide a clear overview and easy-to-follow instructions for anyone interested in using this API. Let me know if you’d like me to clarify any sections further!
>
> This project is licensed under the MIT License. See the [LICENSE](https://github.com/aleexcif/github-repository-stats-api/blob/main/LICENSE) file for details.