https://github.com/John-Lin/awesomelists-index

Generate the awesome lists in JSON file.
https://github.com/John-Lin/awesomelists-index

List: awesomelists-index

Last synced: 11 days ago
JSON representation

Generate the awesome lists in JSON file.

• Host: GitHub
• URL: https://github.com/John-Lin/awesomelists-index
• Owner: John-Lin
• Created: 2015-12-01T10:03:13.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2015-12-20T17:30:20.000Z (almost 9 years ago)
• Last Synced: 2024-05-22T13:36:08.289Z (6 months ago)
• Language: JavaScript
• Homepage:
• Size: 1.42 MB
• Stars: 27
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - John-Lin/awesomelists-index - Generate the awesome lists in JSON file. (JavaScript)

README

        
# awesomelists-index

![npm version](https://badge.fury.io/js/awesomelists-index.svg)

Generate the awesome lists in JSON file.

# Installation

```sh

$ npm install awesomelists-index

```

You can set github token without passing it every time

```sh

$ echo export TOKENS="Your-Github-Token" >> ~/.bash_profile && source ~/.bash_profile

```

# Example Usage

```javascript

'use strict';

let Awesome = require('awesomelists-index');

let options = {

  repo: 'matiassingers/awesome-slack',

  // token is optional parameter

  token: process.env.TOKEN || 'GITHUB_TOKEN',

};

// Given a repository name with author ex: vinta/awesome-python

let py = new Awesome(options);

py.makeIndexJson((err, res) => {console.log(res);});

```

**Run with given github token**

```sh

$ TOKENS="Your-Github-Token" node examples/simple.js

```

# Related

- [lockys/awesome-search](https://github.com/lockys/awesome-search)

- [https://awesomelists.me/](https://awesomelists.me/)