Apache CouchDB
JavaScript HTML CSS Other
Clone or download
Antonio-Maranhao Update dependencies to solve npm audit issues (#1122)
* Update dependencies to fix security issues from npm audit

* Remove underscore dependency

* Updates because lodash v4 removed thisArg parameter

* Replace 'setup' option with 'before' in the dev server config
Latest commit b8d4a30 Aug 10, 2018
Permalink
Failed to load latest commit information.
.github Add/update contribution guidelines, issue/PR templates for GH Issues May 20, 2017
__mocks__ Redux: Permissions - Use Redux for Flux flow Dec 12, 2016
app Update dependencies to solve npm audit issues (#1122) Aug 10, 2018
assets Update dependencies to solve npm audit issues (#1122) Aug 10, 2018
bin make test more robust (#1068) Mar 19, 2018
codemods move first codemod to codemods folder Jun 28, 2016
docker Use a supported CouchDB docker image for selenium tests (#1085) Jun 1, 2018
tasks Allow setting the protocol of the couchdb URL for nightwatch tests (#… Mar 6, 2018
test Allow to resolve conflicts of design documents (#1094) Jun 24, 2018
.babelrc Add async/await polyfill (#1056) Mar 5, 2018
.eslintignore unify jshint and jscs Oct 19, 2015
.eslintrc Upgrade to eslint v4 and enable recommended lint rules (#1043) Jan 4, 2018
.gitignore (#901) - rename all jsx files to js Apr 20, 2017
.npmignore fix packing of fauxton Apr 12, 2016
.travis.yml use npm ci on travis (#1059) Mar 7, 2018
CONTRIBUTING.md Add/update contribution guidelines, issue/PR templates for GH Issues May 20, 2017
Gruntfile.js Run Nightwatch tests with suiteRetries (#1048) Jan 25, 2018
LICENSE add license file, fix author prop Oct 16, 2015
code-layout.md Updated instructions (#997) Oct 16, 2017
couchapp.js remove all unused variables and imports Jan 11, 2017
devserver.js Update dependencies to solve npm audit issues (#1122) Aug 10, 2018
extensions.md Remove compaction addon Feb 15, 2016
i18n.json.default.json Extension for replication authentication methods (#1081) May 2, 2018
index.js Upgrade to eslint v4 and enable recommended lint rules (#1043) Jan 4, 2018
jest-config.json Upgrade to React 16 (#1044) Jan 15, 2018
jest-setup.js Use relative url instead of static urls (#1078) Jun 27, 2018
jest-shim.js Upgrade to React 16 (#1044) Jan 15, 2018
package-lock.json Update dependencies to solve npm audit issues (#1122) Aug 10, 2018
package.json Update dependencies to solve npm audit issues (#1122) Aug 10, 2018
readme.md Fix package.json link (#1082) Jun 1, 2018
settings.json.default.json Use relative url instead of static urls (#1078) Jun 27, 2018
styleguide.md Fix package.json link (#1082) Jun 1, 2018
tests.md Updated instructions (#997) Oct 16, 2017
version-check.js fix fauxton server for module Jan 20, 2016
webpack.config.dev.js Add polyfills for endsWith and startsWith (#1113) Jul 27, 2018
webpack.config.release.js Add polyfills for endsWith and startsWith (#1113) Jul 27, 2018

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 node.js and npm is required. Specifically, Fauxton requires at least Node 6 and npm 3.

  1. Fork this repo (see GitHub help for details)
  2. Clone your fork: git clone https://github.com/YOUR-USERNAME/couchdb-fauxton.git
  3. Go to your cloned copy: cd couchdb-fauxton
  4. 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
  5. Download all dependencies: npm install
  6. 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 installed to use this option.
    • Option 2: Follow instructions found here

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:

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