# fauxton > Fauxton is a modular CouchDB dashboard and Futon replacement. Latest version **1.2.6** (published 2020-09-09) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install fauxton pnpm add fauxton yarn add fauxton bun add fauxton ``` Provides the command `fauxton`. ## Health **Score 30/100 (F)** — status: abandoned. Positive: no vulnerabilities; high maintenance score. Warnings: low downloads; no types; no esm support. Negative: abandoned. ## Facts | | | |---|---| | Version | 1.2.6 | | Published | 2020-09-09 | | First published | 2013-02-08 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 86 | | Unpacked size | 3.5 MB | | Known vulnerabilities | 0 (+12 in 6 direct dependencies) | | Install scripts | no | | GitHub stars | 413 | | Author | The Apache CouchDB contributors | | Maintainers | chewbranca, garrensmith, robertkowalski, benkeen, michellep, willholley, popojargo | | Keywords | couchdb, futon, fauxton | ## Links - npm: https://www.npmjs.com/package/fauxton - Repository: https://github.com/apache/couchdb-fauxton - Homepage: https://github.com/apache/couchdb-fauxton#readme - Issues: https://github.com/apache/couchdb-fauxton/issues - npm.io page: https://npm.io/package/fauxton ## Dependencies (86) - [d3](https://npm.io/package/d3.md) ^3.4.11 - [ajv](https://npm.io/package/ajv.md) ^6.12.3 - [url](https://npm.io/package/url.md) ~0.7.9 - [less](https://npm.io/package/less.md) ^3.11.3 - [nano](https://npm.io/package/nano.md) ~8.0.0 - [rxjs](https://npm.io/package/rxjs.md) ^5.5.12 - [send](https://npm.io/package/send.md) ^0.16.2 - [urls](https://npm.io/package/urls.md) ~0.0.3 - [uuid](https://npm.io/package/uuid.md) ^3.4.0 - [acorn](https://npm.io/package/acorn.md) ^6.4.1 - [async](https://npm.io/package/async.md) ~0.2.6 - [brace](https://npm.io/package/brace.md) ^0.11.0 - [grunt](https://npm.io/package/grunt.md) ^1.2.1 - [react](https://npm.io/package/react.md) ^16.13.1 - [redux](https://npm.io/package/redux.md) ^4.0.5 - [cookie](https://npm.io/package/cookie.md) ^0.3.1 - [eslint](https://npm.io/package/eslint.md) ^6.8.0 - [jquery](https://npm.io/package/jquery.md) ^3.5.1 - [lodash](https://npm.io/package/lodash.md) ^4.17.17 - [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1 - [moment](https://npm.io/package/moment.md) ^2.27.0 - [semver](https://npm.io/package/semver.md) ^5.7.1 - [base-64](https://npm.io/package/base-64.md) ^0.1.0 - [core-js](https://npm.io/package/core-js.md) ^2.6.11 - [express](https://npm.io/package/express.md) ^4.17.1 - [request](https://npm.io/package/request.md) ^2.88.2 - [webpack](https://npm.io/package/webpack.md) ^4.43.0 - [backbone](https://npm.io/package/backbone.md) ^1.4.0 - [bluebird](https://npm.io/package/bluebird.md) ^3.7.2 - [couchapp](https://npm.io/package/couchapp.md) ~0.11.0 - [fs-extra](https://npm.io/package/fs-extra.md) ^2.0.0 - [optimist](https://npm.io/package/optimist.md) ^0.6.1 - [clean-css](https://npm.io/package/clean-css.md) ^4.2.3 - [clipboard](https://npm.io/package/clipboard.md) ^1.5.16 - [grunt-cli](https://npm.io/package/grunt-cli.md) ~1.3.2 - [rc-slider](https://npm.io/package/rc-slider.md) ^9.3.1 - [react-dom](https://npm.io/package/react-dom.md) ^16.13.1 - [@babel/cli](https://npm.io/package/@babel/cli.md) ^7.10.4 - [classnames](https://npm.io/package/classnames.md) ^2.2.6 - [css-loader](https://npm.io/package/css-loader.md) ^3.6.0 - [grunt-exec](https://npm.io/package/grunt-exec.md) ~1.0.1 - [http-proxy](https://npm.io/package/http-proxy.md) ^1.18.1 - [prop-types](https://npm.io/package/prop-types.md) ^15.7.2 - [url-loader](https://npm.io/package/url-loader.md) ^2.3.0 - [@babel/core](https://npm.io/package/@babel/core.md) ^7.10.4 - [file-loader](https://npm.io/package/file-loader.md) ^1.1.11 - [grunt-shell](https://npm.io/package/grunt-shell.md) ^2.1.0 - [less-loader](https://npm.io/package/less-loader.md) ^5.0.0 - [react-redux](https://npm.io/package/react-redux.md) ^7.2.0 - [redux-thunk](https://npm.io/package/redux-thunk.md) ^2.3.0 - [webpack-cli](https://npm.io/package/webpack-cli.md) ^3.3.12 - [babel-eslint](https://npm.io/package/babel-eslint.md) ^9.0.0 - [babel-loader](https://npm.io/package/babel-loader.md) ^8.1.0 - [pouchdb-core](https://npm.io/package/pouchdb-core.md) ^7.2.1 - [react-motion](https://npm.io/package/react-motion.md) ^0.5.0 - [react-select](https://npm.io/package/react-select.md) ^1.3.0 - [style-loader](https://npm.io/package/style-loader.md) ^0.23.1 - [whatwg-fetch](https://npm.io/package/whatwg-fetch.md) ^2.0.4 - [eslint-loader](https://npm.io/package/eslint-loader.md) ^2.2.1 - [expose-loader](https://npm.io/package/expose-loader.md) ^0.7.5 - [jsondiffpatch](https://npm.io/package/jsondiffpatch.md) ^0.3.11 - [exports-loader](https://npm.io/package/exports-loader.md) ~0.6.4 - [grunt-couchapp](https://npm.io/package/grunt-couchapp.md) ~0.2.1 - [imports-loader](https://npm.io/package/imports-loader.md) ^0.8.0 - [react-overlays](https://npm.io/package/react-overlays.md) ^0.7.0 - [react-toastify](https://npm.io/package/react-toastify.md) ^5.5.0 - [@babel/register](https://npm.io/package/@babel/register.md) ^7.10.4 - [jquery-param-fn](https://npm.io/package/jquery-param-fn.md) ^1.0.0 - [react-bootstrap](https://npm.io/package/react-bootstrap.md) ^0.31.3 - [@babel/preset-env](https://npm.io/package/@babel/preset-env.md) ^7.10.4 - [@webcomponents/url](https://npm.io/package/@webcomponents/url.md) ^0.7.5 - [grunt-contrib-copy](https://npm.io/package/grunt-contrib-copy.md) ~1.0.0 - [visualize-rev-tree](https://npm.io/package/visualize-rev-tree.md) 0.0.1 - [webpack-dev-server](https://npm.io/package/webpack-dev-server.md) ^3.11.0 - [@babel/preset-react](https://npm.io/package/@babel/preset-react.md) ^7.10.4 - [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.20.3 - [grunt-contrib-clean](https://npm.io/package/grunt-contrib-clean.md) ~1.1.0 - [html-webpack-plugin](https://npm.io/package/html-webpack-plugin.md) ^3.2.0 - [regenerator-runtime](https://npm.io/package/regenerator-runtime.md) ^0.11.1 - [pouchdb-adapter-http](https://npm.io/package/pouchdb-adapter-http.md) ^7.2.1 - [mini-css-extract-plugin](https://npm.io/package/mini-css-extract-plugin.md) ^0.7.0 - [babel-plugin-array-includes](https://npm.io/package/babel-plugin-array-includes.md) ^2.0.3 - [@babel/plugin-transform-object-assign](https://npm.io/package/@babel/plugin-transform-object-assign.md) ^7.10.4 - [@babel/plugin-proposal-class-properties](https://npm.io/package/@babel/plugin-proposal-class-properties.md) ^7.10.4 - [@babel/plugin-proposal-object-rest-spread](https://npm.io/package/@babel/plugin-proposal-object-rest-spread.md) ^7.10.4 - [@babel/plugin-transform-async-to-generator](https://npm.io/package/@babel/plugin-transform-async-to-generator.md) ^7.10.4 ## Recent versions - 1.2.6 (latest) — 2020-09-09 - 1.2.5 — 2020-06-10 - 1.2.4 — 2020-04-29 - 1.2.2 — 2019-10-15 - 1.2.1 — 2019-10-10 - 1.1.18 — 2018-10-29 - 1.1.15 — 2018-05-02 - 1.1.13 — 2017-07-30 - 1.1.12 — 2017-05-01 - 1.1.11 — 2017-03-27 - 1.1.10 — 2017-03-26 - 1.1.9 — 2016-09-08 - 1.1.8 — 2016-08-24 - 1.1.7 — 2016-08-10 - 1.1.6 — 2016-07-19 - … 16 more at https://npm.io/package/fauxton/versions ## README [![Build Status](https://travis-ci.org/apache/couchdb-fauxton.svg?branch=master)](https://travis-ci.org/apache/couchdb-fauxton) # Fauxton Fauxton is the new Web UI for CouchDB. To get it running in development on your machine. Follow the steps below. ## Install as standalone server via npm You can use the latest release of Fauxton via npm: npm install -g fauxton fauxton See `fauxton --help` for extra options. ## Setting up Fauxton Please note that [node.js](http://nodejs.org/) and npm is required. Specifically, Fauxton requires at least Node 6 and npm 3. 1. Fork this repo (see [GitHub help](https://help.github.com/articles/fork-a-repo/) for details) 1. Clone your fork: `git clone https://github.com/YOUR-USERNAME/couchdb-fauxton.git` 1. Go to your cloned copy: `cd couchdb-fauxton` 1. Set up the upstream repo: * `git remote add upstream https://github.com/apache/couchdb-fauxton.git` * `git fetch upstream` * `git branch --set-upstream-to=upstream/master master` 1. Download all dependencies: `npm install` 1. Make sure you have CouchDB installed. - Option 1 (**recommended**): Use `npm run docker:up` to start a Docker container running CouchDB with user `tester` and password `testerpass`. - You need to have [Docker](https://docs.docker.com/engine/installation/) installed to use this option. - Option 2: Follow instructions [found here](http://couchdb.readthedocs.org/en/latest/install/index.html) ## Running Fauxton **NOTE: Before you run Fauxton, don't forget to start CouchDB!** ### The Dev Server Using the dev server is the easiest way to use Fauxton, especially when developing for it. In the cloned repo folder, type: ``` npm run dev ``` You should be able to access Fauxton at `http://localhost:8000` ### Preparing a Fauxton Release Follow the "Setting up Fauxton" section above, then edit the `settings.json` variable root where the document will live, e.g. `/_utils/`. Then type: ``` npm run couchdb ``` This will install the latest version of Fauxton into `/share/www/` ### To Deploy Fauxton To deploy to your local [CouchDB instance](http://localhost:5984/fauxton/_design/fauxton/index.html): grunt couchapp_deploy ### Build pipeline overview During a release build we are creating a folder called `dist/tmp-out`. It contains all files that are just intermediate results for the final release artifact. Once everything is finished the files are copied from `tmp-out` to their final destination, `dist/release` where they are part of the deployable release artifact. ### (Optional) To avoid a npm global install # Development mode, non minified files npm run couchdebug # Or fully compiled install npm run couchdb ## More information Check out the following pages for a lot more information about Fauxton: - [The Fauxton Code Layout](https://github.com/apache/couchdb-fauxton/blob/master/code-layout.md) - [Style Guide](https://github.com/apache/couchdb-fauxton/blob/master/styleguide.md) - [Testing Fauxton](https://github.com/apache/couchdb-fauxton/blob/master/tests.md) - [Extensions](https://github.com/apache/couchdb-fauxton/blob/master/extensions.md) - [How to contribute](https://github.com/apache/couchdb-fauxton/blob/master/CONTRIBUTING.md) ------ -- The Fauxton Team --- _Source: https://npm.io/package/fauxton · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._