bedrock - npm Package Compare versions

Comparing version 0.1.1 to 0.3.0

package.json

 {
   "name": "bedrock",
-  "version": "0.1.1",
+  "version": "0.3.0",
+  "scripts": {
+    "start": "node index.js",
+    "test": "node index.js test",
+    "lint": "grunt jshint",
+    "ci-lint": "grunt --no-color jshint --mode=ci || exit 0",
+    "coverage": "rm -rf coverage && ./node_modules/.bin/istanbul cover test.js -- --backend --reporter tap && ./node_modules/.bin/istanbul report --root coverage lcov cobertura",
+    "coverage-backend": "rm -rf coverage && ./node_modules/.bin/istanbul cover test.js -- --backend && ./node_modules/.bin/istanbul report --root coverage lcov",
+    "coverage-frontend": "rm -rf coverage && ./node_modules/.bin/istanbul cover test.js -- --frontend && ./node_modules/.bin/istanbul report --root coverage lcov"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/digitalbazaar/bedrock"
+  },
+  "dependencies": {
+    "async": "~0.9.0",
+    "async-node-events": "~0.0.7",
+    "commander": "~2.3.0",
+    "jsonld": "~0.3.19",
+    "mkdirp": "~0.5.0",
+    "pkginfo": "~0.3.0",
+    "underscore": "~1.7.0",
+    "ursa": "v0.8.0",
+    "winston": "~0.7.0",
+    "winston-mail": "~0.2.9"
+  },
+  "optionalDependencies": {
+    "posix": "~1.0.4"
+  },
+  "devDependencies": {
+    "chai": "~1.9.2",
+    "chai-as-promised": "~4.1.0",
+    "grunt": "~0.4.1",
+    "grunt-cli": "~0.1.13",
+    "grunt-contrib-jshint": "~0.10.0",
+    "grunt-jscs": "~1.0.0",
+    "istanbul": "git://github.com/digitalbazaar/istanbul#include-pid",
+    "mocha": "~2.0.1"
+  },
   "engines": {
     "node": ">=0.10.0"
-  }
+  },
+  "directories": {
+    "lib": "./lib/bedrock"
+  },
+  "main": "./lib/bedrock"
 }

README.md

@@ -1,4 +0,160 @@
-bedrock
+Bedrock
 =======
 
-Bedrock
+Note: This README is out-of-date for Bedrock 0.3+.
+
+Bedrock helps you launch your ideas faster by bundling
+all the best-of-breed tooling that's necessary to 
+build a modern, scalable Web app. It can run on a
+low-powered laptop all the way up to enterprise
+servers serving tens of millions of transactions 
+per day.
+
+Bedrock runs on Linux, Mac OS X, and Windows. It
+uses node.js + Express3 + MongoDB for the server 
+backend while utilizing HTML5 + Bootstrap3 + AngularJS
+for the front-end. It has REST APIs, user account 
+management, strong cryptography support, DoS protection, 
+digital signatures, Linked Data, and tons of other 
+[FEATURES][] that are active by default. If you don't 
+need all the fancy features, Bedrock is modular, so 
+you can use only the modules you want.
+
+Quickstart 
+----------
+
+You can follow the following tutorial to setup and use 
+Bedrock on a Linux or Mac OS X development machine.
+
+Requirements
+------------
+
+* Linux or Mac OS X (also works on Windows with some coaxing)
+* node.js >= 0.10.x
+* npm >= 1.4.x
+* mongodb ~= 2.4.x (optional, but strongly recommended)
+
+Setup
+-----
+
+1. Setup an admin user on mongodb (see below)
+2. Map the `bedrock.dev` hostname to your machine (see below).
+3. git clone [e-mail]:digitalbazaar/bedrock.git
+4. cd bedrock && npm install
+5. [optional] Tweak config settings in configs/dev.js
+
+To setup an admin user on mongodb:
+
+1. mongo
+2. use admin
+3. db.addUser( { user: "admin", pwd: "password", roles: [ "clusterAdmin", "readWriteAnyDatabase", "userAdminAnyDatabase", "dbAdminAnyDatabase"] } )
+
+To setup the `bedrock.dev` hostname:
+
+1. Edit the /etc/hosts file as the administrator/root.
+2. Add an entry mapping the IP address to `bedrock.dev`. 
+   For example: `192.168.0.15 bedrock.dev` (where `192.168.0.15` 
+   is the IP address of your primary network device.
+
+Running Bedrock
+---------------
+
+Run the following to start up a development server from the source directory:
+
+    node bedrock.dev.js
+
+To add more verbose debugging, use the `--log-level` option:
+
+    node bedrock.dev.js --log-level debug
+
+To access the server:
+
+1. Go to: https://bedrock.dev:22443/
+2. The certificate warning is normal for development mode. Accept it and 
+   continue to the landing page. 
+3. Login as the admin `admin` with the password `password` or create a new account.
+
+Running the Tests
+-----------------
+
+Install protractor (before first test run):
+
+    npm run install-protractor
+
+Run all backend and frontend tests:
+
+    npm run test
+
+Run just the backend tests:
+
+    npm run test-backend
+
+Run just the frontend tests:
+
+    npm run test-frontend
+
+Run a specific frontend test suite:
+
+    nodejs test.js --frontend --suite unit
+
+Running the Code Coverage Tool
+------------------------------
+
+    npm run coverage
+
+Look at 'coverage.html' using a web browser
+
+Minimizing the RequireJS client-side JS
+---------------------------------------
+
+    npm run minify
+
+To test in dev mode, set the website config var 'minify' to true.
+
+Generating a new self-signed SSL certificate for testing
+--------------------------------------------------------
+
+    nodejs create-credentials.js
+
+Save the generated private key and certificate PEMs in the appropriate files
+(in ./pki/ if using the default config).
+
+Features
+--------
+
+For a complete list of features included in Bedrock, see the [FEATURES][] file.
+
+FAQ
+---
+
+See the [FAQ][] file for answers to frequently asked questions.
+
+Hacking
+-------
+
+See the [CONTRIBUTING][] file for various details for coders about
+hacking on this project.
+
+Authors
+-------
+
+See the [AUTHORS][] file for author contact information.
+
+License
+-------
+
+Bedrock and all Bedrock modules are:
+
+    Copyright (c) 2011-2015 Digital Bazaar, Inc.
+    All Rights Reserved
+
+You can use Bedrock for non-commercial purposes such as self-study, 
+research, personal projects, or for evaluation purposes. See 
+the [LICENSE][] file for details about the included 
+non-commercial license information.
+
+[AUTHORS]: AUTHORS.md
+[FEATURES]: FEATURES.md
+[CONTRIBUTING]: CONTRIBUTING.md
+[FAQ]: FAQ.md
+[LICENSE]: LICENSE.md

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

No License Found

License

(Experimental) License information could not be found.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

85439

increased by74846.49%

Number of package files

24

increased by1100%

Lines of code

1521

increased byInfinity%

Number of lines in readme file

161

increased by3120%

Worsened metrics

Dependency count

11

increased byInfinity%

Dev dependency count

8

increased byInfinity%

License quality

80

decreased by-20%

Number of low supply chain risk alerts

5

increased by400%

Dependency changes

• + Addedasync@~0.9.0

• + Addedasync-node-events@~0.0.7

• + Addedcommander@~2.3.0

• + Addedjsonld@~0.3.19

• + Addedmkdirp@~0.5.0

• + Addedpkginfo@~0.3.0

• + Addedunderscore@~1.7.0

• + Addedursa@v0.8.0

• + Addedwinston@~0.7.0

• + Addedwinston-mail@~0.2.9

• + Addedacorn@0.11.02.7.0(transitive)

• + Addedacorn-globals@1.0.9(transitive)

• + Addedajv@6.12.6(transitive)

• + Addedasn1@0.2.6(transitive)

• + Addedassert-plus@1.0.0(transitive)

• + Addedasync@0.2.100.9.21.5.2(transitive)

• + Addedasync-node-events@0.0.8(transitive)

• + Addedasynckit@0.4.0(transitive)

• + Addedaws-sign@0.2.1(transitive)

• + Addedaws-sign2@0.7.0(transitive)

• + Addedaws4@1.13.2(transitive)

• + Addedbcrypt-pbkdf@1.0.2(transitive)

• + Addedbindings@1.5.0(transitive)

• + Addedboom@0.3.8(transitive)

• + Addedbrowser-request@0.3.3(transitive)

• + Addedcaseless@0.12.0(transitive)

• + Addedcolors@0.6.2(transitive)

• + Addedcombined-stream@0.0.71.0.8(transitive)

• + Addedcommander@2.20.32.3.0(transitive)

• + Addedcontextify@0.1.15(transitive)

• + Addedcookie-jar@0.2.0(transitive)

• + Addedcore-util-is@1.0.2(transitive)

• + Addedcryptiles@0.1.3(transitive)

• + Addedcssom@0.3.8(transitive)

• + Addedcssstyle@0.2.37(transitive)

• + Addedcycle@1.0.3(transitive)

• + Addeddashdash@1.14.1(transitive)

• + Addeddeep-is@0.1.4(transitive)

• + Addeddelayed-stream@0.0.51.0.0(transitive)

• + Addeddom-serializer@0.2.2(transitive)

• + Addeddomelementtype@1.3.12.3.0(transitive)

• + Addeddomhandler@2.4.2(transitive)

• + Addeddomutils@1.7.0(transitive)

• + Addedecc-jsbn@0.1.2(transitive)

• + Addedemailjs@0.3.4(transitive)

• + Addedentities@1.1.22.2.0(transitive)

• + Addedes6-promise@2.0.1(transitive)

• + Addedescodegen@1.14.3(transitive)

• + Addedesprima@4.0.1(transitive)

• + Addedestraverse@4.3.0(transitive)

• + Addedesutils@2.0.3(transitive)

• + Addedextend@3.0.2(transitive)

• + Addedextsprintf@1.3.0(transitive)

• + Addedeyes@0.1.8(transitive)

• + Addedfast-deep-equal@3.1.3(transitive)

• + Addedfast-json-stable-stringify@2.1.0(transitive)

• + Addedfast-levenshtein@2.0.6(transitive)

• + Addedfile-uri-to-path@1.0.0(transitive)

• + Addedforever-agent@0.2.00.6.1(transitive)

• + Addedform-data@0.0.102.3.3(transitive)

• + Addedgetpass@0.1.7(transitive)

• + Addedhar-schema@2.0.0(transitive)

• + Addedhar-validator@5.1.5(transitive)

• + Addedhawk@0.10.2(transitive)

• + Addedhoek@0.7.6(transitive)

• + Addedhtmlparser2@3.10.1(transitive)

• + Addedhttp-signature@1.2.0(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedis-async@0.0.2(transitive)

• + Addedis-typedarray@1.0.0(transitive)

• + Addedisstream@0.1.2(transitive)

• + Addedjsbn@0.1.1(transitive)

• + Addedjsdom@3.1.2(transitive)

• + Addedjson-schema@0.4.0(transitive)

• + Addedjson-schema-traverse@0.4.1(transitive)

• + Addedjson-stringify-safe@3.0.05.0.1(transitive)

• + Addedjsonld@0.3.26(transitive)

• + Addedjsprim@1.4.2(transitive)

• + Addedlevn@0.3.0(transitive)

• + Addedmime@1.2.11(transitive)

• + Addedmime-db@1.52.0(transitive)

• + Addedmime-types@2.1.35(transitive)

• + Addedminimist@1.2.8(transitive)

• + Addedmkdirp@0.5.6(transitive)

• + Addednan@2.22.0(transitive)

• + Addednode-uuid@1.4.8(transitive)

• + Addednwmatcher@1.4.4(transitive)

• + Addedoauth-sign@0.2.00.9.0(transitive)

• + Addedoptionator@0.8.3(transitive)

• + Addedparse5@1.5.1(transitive)

• + Addedperformance-now@2.1.0(transitive)

• + Addedpkginfo@0.3.1(transitive)

• + Addedposix@1.0.4(transitive)

• + Addedprelude-ls@1.1.2(transitive)

• + Addedpsl@1.13.0(transitive)

• + Addedpunycode@2.3.1(transitive)

• + Addedqs@0.5.66.5.3(transitive)

• + Addedreadable-stream@3.6.2(transitive)

• + Addedrequest@2.16.62.88.2(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedsafer-buffer@2.1.2(transitive)

• + Addedsntp@0.1.4(transitive)

• + Addedsource-map@0.6.1(transitive)

• + Addedsshpk@1.18.0(transitive)

• + Addedstack-trace@0.0.10(transitive)

• + Addedstring_decoder@1.3.0(transitive)

• + Addedtough-cookie@2.5.0(transitive)

• + Addedtunnel-agent@0.2.00.6.0(transitive)

• + Addedtweetnacl@0.14.5(transitive)

• + Addedtype-check@0.3.2(transitive)

• + Addedunderscore@1.4.41.7.0(transitive)

• + Addeduri-js@4.4.1(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• + Addeduuid@3.4.0(transitive)

• + Addedverror@1.10.0(transitive)

• + Addedwinston@0.7.3(transitive)

• + Addedwinston-mail@0.2.9(transitive)

• + Addedword-wrap@1.2.5(transitive)

• + Addedxml-name-validator@1.0.0(transitive)

• + Addedxmldom@0.1.19(transitive)

• + Addedxmlhttprequest@1.8.0(transitive)