Code Monkey home page Code Monkey logo

puton's Introduction

Puton (Futon for PouchDB)

**Puton is no longer maintained. Check out the PouchDB inspector for Chrome and PouchDB inspector for Firefox

Puton is to PouchDB what Futon is to CouchDB.

The general idea is to provide a simple way to inspect a browser's PouchDB.

There are several constraints in this regards (same origin policy being one of them). Consequently, Puton is implemented as a javascript bookmarklet so that it can be injected into the relevant pages and access the pages' pouchdb documents.

Developing puton

To get started, run the following commands:

  • install grunt-cli
$ npm install -g grunt-cli
  • install npm dependencies
$ npm install
  • starts puton
node puton.js
  • starts puton in production mode
$ NODE_ENV=production node puton.js

Grunt tasks

  • lint
    • Lint the various files
  • build:all
    • concatenate lib files
    • uglify lib files
    • grunt build
  • build
    • concatenate script files
    • uglify script files
    • concat lib.min with script.min
  • minify
    • minify css files
  • updatelibs
    • Updates Backbone, Underscore, jQuery
    • build:lib
  • updatepouch
    • Update Pouch to latest version
  • test
    • Runs Jasmine tests
  • browser
  • release (default task)
    • lint
    • updatepouch
    • test
    • build
    • minify
  • run: Starts Puton

puton's People

Contributors

ymichael avatar zichun avatar

Stargazers

RichMie avatar Thejesh GN avatar Zach Sim avatar Mikal avatar Mathieu Leplatre avatar  avatar Fabien Bourgeois avatar Brian Immel avatar Sjoerd de Jong avatar Malte Legenhausen avatar  avatar Tim Spann avatar Pierre Haufe avatar Joseph Chiocchi avatar Spencer Herzberg avatar Askar Yusupov avatar Markuso avatar Alex Schedler avatar Hans Gremmen avatar Octavian A. Damiean avatar Max Desiatov avatar Brad Pillow avatar Orlin M Bozhinov avatar Nick Thompson avatar Paul Capestany avatar j chesley avatar  avatar  avatar Nuno Job avatar

Watchers

James Cloos avatar  avatar  avatar

Forkers

indolering

puton's Issues

Plug and play

I want to use this to enable developers to manage the PouchDB from my server. I can handle CORS and requiring them to create a bookmarklet just gets in the way.

Can I just get the html/css/js files needed to just plunk it on my server?

remove express dependency

unnecessary imo. just need a simple python -m SimpleHTTPServer or equivalent in node.

preferably, use same the same dependencies as pouchdb

Handle error when opening old database

I have previously created database with puton that cant be opened, while we will be fixing that in pouchdb itself, it would be handy if puton told me it couldnt open the database

Join with Fauxton?

This is just a suggestion, so feel free to close if its not something that interests you.

There has been a lot of work on a new admin interface to CouchDB to replace futon called fauxton. Its based on backbone so it should be possible to replace the backend and have it use pouchdb, the fauxton codebase has been built in a pluggable way so the front end is customisable and any ideas you had about interfaces could be built as plugins, but it would mean getting a whole bunch of functionality for free

https://github.com/cloudant-labs/couchdb/tree/fauxton/src/fauxton
https://npmjs.org/package/fauxton
https://github.com/jo/backbone-pouchdb

add README

need more documentation on how to start contributing/development

$ is not defined

when injecting bookmarklet.js $ is not defined. cannot assume that jquery is loaded

Chrome extension links are broken

The README says "Check out the PouchDB inspector for Chrome and PouchDB inspector for Firefox" but neither of those links work.

Do you have a fresher one? Or is there a better tool for this?

Need to specify idb://dbname

I dont quite know why, puton didnt seem to do much for me until I realised I needed to prefix the dbname with idb:// otherwise it tried to use the http adapter (is it using an old version of pouch?)

tab views state

switching between tabs re-render the view, which is problematic when say, i'm editting a document halfway and need to look at a view query result etc.

Creating a document is hard

This is more about ui, entering a JSON string into a prompt is quite awkward, I think a textbox as is used for editing a document would be nicer

It may also be worth looking to integrate http://www.jsoneditoronline.org/ or something similiar (just the plain json view)

Bookmarklet not working on Chrome

Either the Puton UI doesn't display or it states "No Existing Pouches" when in fact there is one. Tested with both localhost and public site.

Win 7 64, Chrome 35.0.1916.153 m

CORS documentation

You should put up some documentation on how to use this as a generic DB frontend for JS webapps. It shouldn't a problem with CORS.

loadScripts is too slow

clicking on the bookmarklet takes a perceptible amount of time to load the entire thing..

Can't read existing databases

I'm new to this, and so perhaps I'm missing something obvious, but when I load Puton, it tells me there are no existing pouches, when I know that there is at least one. In playing around with it, I have now created two additional databases that show up, although they are not accessible to the app that I am developing.

Please tell me what I am missing.

Thanks,
Wayne

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.