Package Health Score

61 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Active

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
1.2.6	\|	09/2020	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.18	\|	10/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.0	\|	01/2014		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.0.1	\|	02/2013		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (13)

GitHub Stars: 379
Forks: 224
Contributors: 80

Direct Usage Popularity

The npm package fauxton receives a total of 13 downloads a week. As such, we scored fauxton popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package fauxton, we found that it has been starred 379 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 80
Funding: No

With more than 10 contributors for the fauxton repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 61
Open PR: 6
Last Release: 4 years ago
Last Commit: 23 days ago

Further analysis of the maintenance status of fauxton based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for fauxton is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 12 years
Dependencies: 86 Direct
Versions: 32
Install Size: 3.62 MB
Dist-tags: 1
# of Files: 63
Maintainers: 7
TS Typings: No

fauxton has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

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.

Fork this repo (see GitHub help for details)
Clone your fork: git clone https://github.com/YOUR-USERNAME/couchdb-fauxton.git
Go to your cloned copy: cd couchdb-fauxton
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
Download all dependencies: npm install
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 https://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

fauxton dependencies

@babel/cli @babel/core @babel/plugin-proposal-class-properties @babel/plugin-proposal-object-rest-spread @babel/plugin-transform-async-to-generator @babel/plugin-transform-object-assign @babel/preset-env @babel/preset-react @babel/register @webcomponents/url acorn ajv async babel-eslint babel-loader babel-plugin-array-includes backbone base-64 bluebird brace classnames clean-css clipboard cookie core-js couchapp css-loader d3 eslint eslint-loader eslint-plugin-react exports-loader expose-loader express file-loader fs-extra grunt grunt-cli grunt-contrib-clean grunt-contrib-copy grunt-couchapp grunt-exec grunt-shell html-webpack-plugin http-proxy imports-loader jquery jquery-param-fn jsondiffpatch less less-loader lodash mini-css-extract-plugin mkdirp moment nano optimist pouchdb-adapter-http pouchdb-core prop-types rc-slider react react-bootstrap react-dom react-motion react-overlays react-redux react-select react-toastify redux redux-thunk regenerator-runtime request rxjs semver send style-loader url url-loader urls uuid visualize-rev-tree webpack webpack-cli webpack-dev-server whatwg-fetch

fauxton development dependencies

babel-jest bootstrap enzyme enzyme-adapter-react-16 es5-shim fetch-mock jest mock-local-storage nightwatch node-fetch redux-mock-store sinon

FAQs

What is fauxton?

Fauxton is a modular CouchDB dashboard and Futon replacement. Visit Snyk Advisor to see a full health score report for fauxton, including popularity, security, maintenance & community analysis.

Is fauxton popular?

The npm package fauxton receives a total of 13 weekly downloads. As such, fauxton popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is fauxton well maintained?

We found indications that fauxton is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is fauxton safe to use?

While scanning the latest version of fauxton, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 15 November-2024, at 18:38 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP