Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jarrodnorwell/githubtrendingapi

GitHubTrendingAPI is the middleman of GitHubTrending, built using Vapor and written entirely in Swift, GitHubTrendingAPI handles all communication between frontends, whether they be an application, script or website and the backend.
https://github.com/jarrodnorwell/githubtrendingapi

api code git github spm swift trending vapor

Last synced: about 2 hours ago
JSON representation

GitHubTrendingAPI is the middleman of GitHubTrending, built using Vapor and written entirely in Swift, GitHubTrendingAPI handles all communication between frontends, whether they be an application, script or website and the backend.

Awesome Lists containing this project

README

        

# GitHubTrendingAPI
GitHubTrendingAPI is a middleman of GitHubTrending, built using Vapor and written entirely in Swift, GitHubTrendingAPI handles all communication between frontends, whether they be an application, script or website and the backend.

## Prerequisites
### Databases
- **[MongoDB](https://mongodb.com)** (preferred)
- MySQL
- PostgreSQL
- SQLite

### Frameworks
- **[Vapor](https://github.com/vapor/vapor)**

### Operating System
- Linux (preferred)
- macOS
- Linux on Windows with **[WSL2](https://learn.microsoft.com/en-us/windows/wsl/install)**

### Programming Languages
- **[Swift](https://www.swift.org)**

## Getting Started
### Change Directory
```bash
$ cd /path/to/directory
```

### Clone Repository
```bash
$ git clone https://github.com/jarrodnorwell/GitHubTrendingAPI
```

### Change Directory, Build & Run
```bash
$ cd GitHubTrendingAPI
$ swift build -c release
$ .build/release/GitHubTrendingAPI
```

## Final Notes
Once GitHubTrendingAPI is running, head over to **[GitHubTrendingScraper](https://github.com/jarrodnorwell/GitHubTrendingScraper)**