npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@naturalcycles/github-db

v1.3.0

Published

GitHub branch as a Database

Downloads

39

Readme

@naturalcycles/github-db

GitHub branch as a Database

npm min.gz size code style: prettier

Intro

Store your data for free in GitHub repo branch. Similar to gh-pages, but for data.

Implements CommonDB interface.

Store as *.ndjson (newline-delimited json), or *.ndjson.gz (gzipped), or *.sqlite (binary).

Push to preserve git commit history or force-push to reset history and only store the recent state.

Example

const db = new FileDB({
  plugin: new GithubPersistencePlugin({
    token: 'YOUR_GITHUB_TOKEN',
    repo: 'NaturalCycles/github-db',
  }),
})

const items = [
  { id: 'id1', a: 'a1' },
  { id: 'id2', a: 'a2' },
]

await db.saveBatch('TEST_TABLE', items)

It will create, commit and push data/TEST_TABLE.ndjson file to the repo/branch that you've specified (branch defaults to gh-data, similarly to gh-pages).

Next saves will be either new commits, or force-push of new commit over previous (with forcePush: true option).

Currently, it needs some preparation steps to work (create empty branch), described further down.

Prepare an empty branch to store your data

Replace [email protected]:NaturalCycles/github-db.git with your repo.

Replace gh-data with the desired branch name (but gh-data is the default).

mkdir data && cd data
git clone [email protected]:NaturalCycles/github-db.git ./
git checkout --orphan gh-data
git reset --hard
git commit --allow-empty -m "chore: init empty data branch"
git push --set-upstream origin gh-data

TODO

  • [ ] .ndjson.gzip option
  • [ ] .sqlite option
  • [ ] command to vacuum/force-push all commits in gh-data into one