https://github.com/ngryman/asmr

Show a list of your repos. That's it!
https://github.com/ngryman/asmr

Last synced: about 2 months ago
JSON representation

Show a list of your repos. That's it!

• Host: GitHub
• URL: https://github.com/ngryman/asmr
• Owner: ngryman
• License: mit
• Created: 2016-02-24T16:22:47.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-10-14T23:40:37.000Z (almost 7 years ago)
• Last Synced: 2024-07-26T20:58:15.772Z (about 2 months ago)
• Language: JavaScript
• Size: 52.7 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# asmr [![travis][travis-image]][travis-url] [![codecov][codecov-image]][codecov-url]

[travis-image]: https://img.shields.io/travis/ngryman/asmr.svg?style=flat

[travis-url]: https://travis-ci.org/ngryman/asmr

[codecov-image]: https://img.shields.io/codecov/c/github/ngryman/asmr.svg

[codecov-url]: https://codecov.io/github/ngryman/asmr

> Show a list of your repos. That's it!

**Abracadabra Show My Repos** *(asmr)* allows you to display a simple up-to-date list of your

github repositories.

You can use it out of the box or customize things.

## Install

```bash

npm install --save asmr

```

## Usage

```javascript

asmr('ngryman', document.body)

asmr('ngryman', 'body')

// pagination

asmr('ngryman', 'body', { page: 1, perPage: 10 })

// custom template

asmr('ngryman', 'body', {

  template: '{name}'

})

// custom processing

asmr('ngryman', 'body', { render: false })

  .then(function(baton) {

    baton.repos.sort(function(r1, r2) {

      return r2.stargazers_count - r1.stargazers_count

    })

    return baton

  })

  .then(asmr.render)

```

## API

### asmr(user, target, [options])

#### `user` `{string}`

Name of the user to pull repositories for.

#### `target` `{node|string}`

Target element where to display the list. Each elements of the list will be appended to that `target`. You can either pass a *selector* or the `dom` element itself.

#### `options` `{object}`

##### `perPage` `{number}`

Set how many items will be rendered. Default is `30`.

##### `page` `{number}`

Displays the given `page`. The index of the first element is `(page - 1) * perPage`.

##### `template` `{string}`

Use `template` for each repo rendering. Every `{property}` occurrence will be replace by its corresponding repo value. For a list of available properties, see an example of repo structure [here](https://developer.github.com/v3/repos/#response).

**Example**:

```html

	
{name}{language}



	
{description}

	


		{forks_count}

		{watchers_count}

		{stargazers_count}

	


```

##### `render` `{boolean}`

If set to `false`, `asmr` only fetches data but does not render anything. It's useful if you want to customize things before rendering with `asmr.render`, or if you simply want to fetch repos.

Note that instead of resolving `repos`, it resolves a `baton` which basically holds everything you need to continue processing, including repos.

### asmr.render(baton)

The rendering method itself. It basically iterates over `baton.repos`, create `dom` nodes using `template` and append it to `baton.target`.

You can use it after custom processing, or as a standalone.

## Why this name?

From [Autonomous Sensory Meridian Response].

[Autonomous Sensory Meridian Response]: https://www.wikiwand.com/en/Autonomous_sensory_meridian_response

## License

MIT © [Nicolas Gryman](http://ngryman.sh)