https://github.com/ldakhoa/gisthub-server

https://github.com/ldakhoa/gisthub-server

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/ldakhoa/gisthub-server
• Owner: ldakhoa
• License: mit
• Created: 2023-07-30T16:32:09.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-12T13:36:34.000Z (10 months ago)
• Last Synced: 2024-03-12T14:36:00.323Z (10 months ago)
• Language: TypeScript
• Size: 227 KB
• Stars: 0
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GistHub Server

GistHub Server is a Node.js web server that provides the functionality of retrieving starred gists from a user on GitHub. It is built to overcome the lack of an open API for this feature.

A cron job is set up in the GistHub Server to retrieve and update the starred gists. This cron job runs every 8 hours to ensure that the data parsed from the GitHub HTML is up to date and accurate.

This server mainly is used by [GistHub iOS App](https://github.com/ldakhoa/gisthub).

## Installation

To get started, run these instructions:

```shell

npm install

npm run dev

```

Once the server is running, you can retrieve starred gists and discover gists from a specific user by making a GET request to the following endpoint:

```

GET https://127.0.0.1:8787/users//starred?page=

GET http://127.0.0.1:8787/discover?page=

GET http://127.0.0.1:8787/discover/starred?page=

GET http://127.0.0.1:8787/discover/forked?page=

```

## License

We will ship GistHub on the App Store for free and open source entire source code as well, GistHub is licensed under [MIT](./LICENSE) so that you can do whatever you want with this source code.

However, **please do not ship this app** under your own account.