couchapp

Utilities to make standalone CouchDB application development simple

  • 所有者: couchapp/couchapp
  • 平台:
  • 许可证: Apache License 2.0
  • 分类:
  • 主题:
  • 喜欢:
    0
      比较:

Github星跟踪图

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 <http://jquery.com>_ plugin
designed to bring clarity and order to the freedom of
CouchDB <http://couchdb.apache.org>_'s document-based approach.

Also, be sure to checkout our Erlang-based sibling,
erica <https://github.com/benoitc/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 <https://couchapp.readthedocs.org/en/latest/couchapp/install.html#installing-on-windows>_.

More installation options on the website <https://couchapp.readthedocs.org/en/latest/couchapp/install.html>_.

Getting started

Read the tutorial <https://couchapp.readthedocs.org/en/latest/couchapp/gettingstarted.html>_.

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 <http://nose.readthedocs.org/>. and
nose-testconfig <https://pypi.python.org/pypi/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 <https://couchapp.readthedocs.org/en/latest/user/list-of-couchapps.html>_

主要指标

概览
名称与所有者couchapp/couchapp
主编程语言Python
编程语言Python (语言数: 8)
平台
许可证Apache License 2.0
所有者活动
创建于2009-05-22 10:17:24
推送于2018-08-16 02:46:34
最后一次提交2018-08-16 10:46:30
发布数38
最新版本名称1.0.2 (发布于 )
第一版名称0.1.11 (发布于 2009-02-20 17:54:20)
用户参与
星数826
关注者数28
派生数99
提交数1.3k
已启用问题?
问题数182
打开的问题数24
拉请求数57
打开的拉请求数1
关闭的拉请求数12
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?