https://github.com/antoine-coulon/openforker

Helps developers view, chose and fork a GitHub repository🔗🌎
https://github.com/antoine-coulon/openforker

Last synced: 17 days ago
JSON representation

Helps developers view, chose and fork a GitHub repository🔗🌎

• Host: GitHub
• URL: https://github.com/antoine-coulon/openforker
• Owner: antoine-coulon
• Created: 2021-03-17T17:45:21.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-28T00:47:51.000Z (9 months ago)
• Last Synced: 2024-10-09T10:06:25.503Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 212 KB
• Stars: 3
• Watchers: 1
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        



    OpenForker 🔗🌎





    CLI / API helping developers view, chose and fork an open-source GitHub repository





    

    





    



## Getting started

### CLI Mode

To use OpenForker as a CLI :

```console

$ npm install openforker -g 

```

* explore GitHub trends by language and filter them by period

```console

$ forker trends --language --period

```

* directly fork a repository by knowing author & repository name, then clones it locally and open a browser tab

on the forked repository

```console

$ forker use discordjs/discord.js --clone

```

### API Mode

To use OpenForker as an API :

```console

$ npm install openforker

```

```js

const forker = require('openforker');

(async () => {

    await forker.forkOne({ owner: "discordjs", repositoryName: "discord.js"})

})().catch();

```

## Authentication

OpenForker uses [Auth0](https://auth0.com/) to provide secure access to GitHub API.