Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/splitscreen-me/splitscreenme-hub
SplitScreen.Me - Public Hub 📦
https://github.com/splitscreen-me/splitscreenme-hub
ant-design antlr4 gaming gaming-website javascript meteorjs mongodb react reactjs splitscreen
Last synced: about 1 month ago
JSON representation
SplitScreen.Me - Public Hub 📦
- Host: GitHub
- URL: https://github.com/splitscreen-me/splitscreenme-hub
- Owner: SplitScreen-Me
- Created: 2020-03-17T22:29:39.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-03T14:36:40.000Z (3 months ago)
- Last Synced: 2024-10-14T03:41:53.464Z (about 1 month ago)
- Topics: ant-design, antlr4, gaming, gaming-website, javascript, meteorjs, mongodb, react, reactjs, splitscreen
- Language: JavaScript
- Homepage: https://hub.splitscreen.me
- Size: 920 KB
- Stars: 12
- Watchers: 5
- Forks: 4
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# SplitScreen.Me Hub 📦
## About the Hub 📦
The Hub is created using [Meteor](https://www.meteor.com/), [React](https://www.reactjs.org), [Antd Design](https://ant.design/).
Feel free to [contribute](#contribute) and help us build the most amazing **hub for splitscreened games** ever!
## Basic API 🔥
Handler research:
```
url: "api/v1/handlers/:search_text",
httpMethod: "get"
```
Get all handlers (up to 500):
```
url: "api/v1/allhandlers",
httpMethod: "get"
```
Specific handler infos:
```
url: "api/v1/handler/:handler_id",
httpMethod: "get"
```
Get available packages for one handler:
```
url: "api/v1/packages/:handler_id",
httpMethod: "get"
```
Get package info:
```
url: "api/v1/packages/:package_id",
httpMethod: "get"
```
Get comments done by users about a handler:
```
url: "api/v1/comments/:handler_id",
httpMethod: "get"
```
Download a package from it's ID:
```
url: /cdn/storage/packages/:package_id/original/handler-{handler_id}-v{version_of_handler}.nc?download=true
httpMethod: "get"
```
Get IGDB screenshots for a handler:
```
url: "api/v1/screenshots/:handler_id",
httpMethod: "get"
```
## Contribute
### Prerequisites
1. IDE or text editor. for example [WebStorm](https://www.jetbrains.com/webstorm/) or [VSCode](https://code.visualstudio.com/)
2. IDE for MongoDB, we recommend [NoSQLBooster](https://nosqlbooster.com/)
#### Installation
You must use Node v12 and not a higher version.
```
$ npm install
```
#### Local Development
```
$ npm run dev
```
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.