README.md

This repository contains several distinct things related to BrowserID:

the browserid server - a node.js server which implements a web services api, stores a record of users, the email addresses they've verified, a bcrypted password, outstanding verification tokens, etc

the verifier - a stateless node.js server which does cryptographic verification of assertions. This thing is hosted on browserid.org as a convenience, but people using browserid can choose to host their own version if they wish to.

sample and test code - to test the above

the browserid.org website - the templates, css, and javascript that make up the visible part of browserid.org

the javascript/HTML dialog & include library - this is include.js and the code that it includes, the bit that someone using browserid will include.

Getting started:

visit the demo application ('rp') in your web browser (url output on the console at runtime)

You can stop the servers with a Cntl-C in the terminal.

Staying up to date:

rm -Rf var node_modules

npm install

Testing

Local Testing

Unit tests can be run by invoking npm test at the top level. At present,
there are three classes of unit tests to be run:

Backend unit tests against a custom, zero-dependency JSON database

Backend unit tests against MySQL, what we use in production

Frontend unit tests run headlessly against PhantomJS

You can control which tests are run using the WHAT_TESTS env var, see
scripts/test for details.

Continuous Integration Testing

Integration tests are done with Travis-CI. It is recommended that you setup Travis-CI for your BrowserID fork so that tests are automatically run when you push changes. This will give the BrowserID team confidence that your changes both function correctly and do not cause regressions in other parts of the code. Configuration files are already included in the repo but some setup is necessary.

Development model

branching & release model - You'll notice some funky branching conventions, like the default branch is named dev rather than master as you might expect. We're using gitflow: the approach is described in a blog post.

contributions - please issue pull requests targeted at the dev branch

LICENSE

All source code here is available under the MPL 2.0 license, unless
otherwise indicated.