Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/couchapp/couchapp

Utilities to make standalone CouchDB application development simple
https://github.com/couchapp/couchapp

couchapp couchdb

Last synced: about 1 month ago
JSON representation

Utilities to make standalone CouchDB application development simple

Awesome Lists containing this project

README 

        
CouchApp: Standalone CouchDB Application Development Made Simple

================================================================

.. image:: https://img.shields.io/travis/couchapp/couchapp/master.png?style=flat-square

   :target: https://travis-ci.org/couchapp/couchapp



.. image:: https://img.shields.io/coveralls/couchapp/couchapp/master.png?style=flat-square

   :target: https://coveralls.io/r/couchapp/couchapp



.. image:: https://readthedocs.org/projects/couchapp/badge/?version=latest&style=flat-square

   :target: https://couchapp.readthedocs.org/en/latest



CouchApp is designed to structure standalone CouchDB application

development for maximum application portability.



CouchApp is a set of scripts and a `jQuery `_ plugin

designed  to bring clarity and order to the freedom of

`CouchDB `_'s document-based approach.



Also, be sure to checkout our Erlang-based sibling,

`erica `_.



.. contents:: Table of Contents



Write apps using just JavaScript and HTML

-----------------------------------------



Render HTML documents using JavaScript templates run by CouchDB. You'll

get parallelism and cacheability, **using only HTML and JS.** Building

standalone CouchDB applications according to correct principles affords

you options not found on other platforms.



Deploy your apps to the client

++++++++++++++++++++++++++++++



CouchDB's replication means that programs running locally can still be

social. Applications control replication data-flows, so publishing

messages and subscribing to other people is easy. Your users will see

the benefits of the web without the hassle of requiring always-on

connectivity.



Installation

------------



Couchapp requires Python 2.6 or greater but not in Python3.

Couchapp is most easily installed using the latest versions of the standard

python packaging tools, ``setuptools`` and ``pip``.

They may be installed like so::



    $ curl -O https://bootstrap.pypa.io/get-pip.py

    $ sudo python get-pip.py



Installing couchapp is then simply a matter of::



    $ pip install couchapp



or this way if you cannot access the root (or due to SIP on macOS),

then find the executable at ``~/.local/bin``.

For more info about ``--user``, please checkout ``pip help install``::



    $ pip install --user couchapp



To install/upgrade a development version of couchapp::



    $ pip install -e git+http://github.com/couchapp/couchapp.git#egg=Couchapp



Note: Some installations need to use *sudo* command before each command

line.



Note: On debian system don't forget to install python-dev.



To install on Windows follow instructions `here

`_.



More installation options on the `website

`_.



Getting started

---------------



Read the `tutorial `_.



Documentation

-------------



The document of ``master`` branch is available at

https://couchapp.readthedocs.io/en/latest.



Branch ``stable-1.0`` is here: http://couchapp.readthedocs.io/en/stable-1.0/



Testing

-------



We use `nose `_. and

`nose-testconfig `_. for setting

up and running tests.



::



    $ python setup.py nosetests



Config

++++++



Our ``nosetests`` will run with options listed in ``setup.cfg``.



In the ``tests`` directory, copy ``config.sample.ini`` to ``config.ini``, tweak

the settings, and then modify your ``setup.cfg``::



    [nosetests]

    ...

    tc-file=tests/config.ini



Coverage

++++++++



If you're wanting to examine code coverage reports (because you've got big

plans to make our tests better!), you can browse around the ``cover`` dir ::



    $ cd cover

    $ python2 -m SimpleHTTPServer



or (if you prefer python3)::



    $ python3 -m http.server



Debug

+++++



If you want to debug the failed run with ``pdb``, add the following option to

``setup.cfg``::



    [nosetests]

    ...

    pdb=1



Thanks for testing ``couchapp``!



Building the docs

-----------------



We generate the document via ``sphinx``.



First, prepare our building env.

We need ``sphinx``::



    $ cd docs/

    $ pip install sphinx



To build it, just issue::



    $ make html



And sphinx will generate static html at *docs/_build/html*.

We can browse the site from this dir already.



Other resources

---------------



* `List of CouchApps `_