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

@papermerge/commander

v0.5.0

Published

[![Unittests](https://github.com/papermerge/document-commander/actions/workflows/unittests.yml/badge.svg)](https://github.com/papermerge/document-commander/actions/workflows/unittests.yml)

Downloads

27

Readme

Unittests

Document Commander

NodeJs package for (reusable) client side files browsing i.e. javascript code for navigating documents and folders. Provides look and feel of typical modern desktop file manager e.g. Gnome's Files App. Document Commander is part by Papermerge Core.

Commander

Requirements

The core requirements for this project are NodeJs, npm (node package manager) and webpack:

Installation

Install all nodejs dependent packages:

$ npm i  # looks in package.json and installs dependencies

Playground

In site/ folder there is a flask based project used as playground. In order to setup and run playground, use following commands:

$ cd site
$ virtualenv .venv -p /usr/bin/python3.7
$ source .venv/bin/activate
$ pip install -r requirements.txt
$ cd ..
$ make run

Document Commander API

At vary basic, you can instanciate Document Commander and open root folder as follows::

let DC = DocummentCommander, commander;

commander = new DC.CommanderView({
    'el': '#commander'
});
commander.open();

Where #commander is some DOM div element. Notice when commander.open method is without arguments Commander will open root folder i.e. will issue request GET /core/folder/ from the server side. The core part of the url request is so called urlconf prefix. If no further configuration is provided, default urlconf prefix is used - which is /core.

You can change default urlconf prefix as follows::

let DC = DocummentCommander, commander;

DC.urlconf.prefix = "/app";
commander = new DC.CommanderView({
    'el': '#commander'
});
commander.open();

In this case DocumentCommander will issue GET /app/folder http request to fetch root folder data.

In order to open at specific folder, provide that folder as named parameter to open method::

let DC = DocummentCommander,
    commander,
    folder;

commander = new DC.CommanderView({
    'el': '#commander'
});
folder = new DC.Folder({id: 3});
commander.open({folder});

In this case Document Commander will fetch folder nodes from GET /core/folder/3/ location.