/couchdb-fauxton mirrored from git://git.apache.org/couchdb-fauxton.git

Mirror of Apache CouchDB
  1. JavaScript 77.1%
  2. HTML 14.6%
  3. CSS 8.2%
  4. Other 0.1%
JavaScript HTML CSS Other
Find file
Latest commit a766d34 Jan 9, 2017 @garrensmith garrensmith Make clipboard copy tests more robust
Permalink
Failed to load latest commit information.
__mocks__ Redux: Permissions - Use Redux for Flux flow Dec 12, 2016
app Make clipboard copy tests more robust Jan 9, 2017
assets rip and replace zeroclipboard with clipboardjs Dec 23, 2016
bin use onepanel react layout for all routes Nov 22, 2016
codemods move first codemod to codemods folder Jun 28, 2016
docker use latest docker Nov 21, 2016
tasks Move to all React Dec 8, 2016
test remove tray and use only traycontents Dec 15, 2016
.babelrc convert all files to use import May 31, 2016
.eslintignore unify jshint and jscs Oct 19, 2015
.eslintrc Redux: Permissions - Use Redux for Flux flow Dec 12, 2016
.gitignore Run tests in browser with webpack Sep 13, 2016
.npmignore fix packing of fauxton Apr 12, 2016
.travis.yml Move to all React Dec 8, 2016
CONTRIBUTING.md Update Fauxton docs Aug 31, 2015
Gruntfile.js Move to all React Dec 8, 2016
LICENSE add license file, fix author prop Oct 16, 2015
code-layout.md Remove compaction addon Feb 15, 2016
couchapp.js fix comma spacing Oct 19, 2015
devserver.js devserver: readd/fix csp header Oct 6, 2016
extensions.md Remove compaction addon Feb 15, 2016
i18n.json.default.json Complete new replication redesign Nov 16, 2016
index.js Move selenium to docker Jul 12, 2016
jest-config.json Redux: Permissions - Use Redux for Flux flow Dec 12, 2016
jest-setup.js rip and replace zeroclipboard with clipboardjs Dec 23, 2016
package.json rip and replace zeroclipboard with clipboardjs Dec 23, 2016
readme.md add build status badge Sep 28, 2016
settings.json.default.json remove blacklist tests Jul 12, 2016
styleguide.md Styleguide update Nov 28, 2014
tests.md Simplify selenium testing Jul 12, 2016
version-check.js fix fauxton server for module Jan 20, 2016
webpack.config.dev.js react: port config section to react Sep 13, 2016
webpack.config.release.js remove sourcemaps in webpack Sep 14, 2016
webpack.config.test-dev.js Run tests in browser with webpack Sep 13, 2016
webpack.config.test.js Complete new replication redesign Nov 16, 2016

readme.md

Build Status

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 a recent installation of node.js and npm is required.

  1. make sure you have CouchDB installed. Instructions on how to install it can be
    found here
  2. fork this repo: git clone https://github.com/apache/couchdb-fauxton.git
  3. add upstream to the private apache repo: git remote add upstream http://git-wip-us.apache.org/repos/asf/couchdb-fauxton.git
  4. go to your cloned copy of the repo (usually couchdb-fauxton) and type npm install to download all dependencies

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

Wait until you see the "Fauxton" ascii art on your command line, then 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:

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 Team