diff options
| author | ag_dubs <ashley666ashley@gmail.com> | 2015-09-11 15:21:13 -0400 |
|---|---|---|
| committer | ag_dubs <ashley666ashley@gmail.com> | 2015-09-11 17:19:46 -0400 |
| commit | 1e592342b7d55d3cd916a711fdbc5b7ca9ada12a (patch) | |
| tree | 8dc7f5cb34b87bebdedcda73329933c6de68059d | |
| parent | 19ba22b11c98af0a9043e954ae9ef540181b78c9 (diff) | |
improve readmereadme
- add more details to description
- add prerequisites section
- improve up and running section
- improve environment config section
| -rw-r--r-- | README.md | 45 |
1 files changed, 18 insertions, 27 deletions
@@ -1,24 +1,25 @@ # id.webmaker.org +> OAuth 2.0 identity provider for Webmaker [](https://travis-ci.org/mozilla/id.webmaker.org) +[](https://codeclimate.com/github/mozilla/id.webmaker.org) +[](https://david-dm.org/mozilla/id.webmaker.org) -OAuth 2.0 identity provider for Webmaker +`id.webmaker.org` is an application with a [`hapi`](http://hapijs.com) backend and [`react`](http://facebook.github.io/react) frontend that serves as the OAuth 2.0 identity provider for [Webmaker](http://webmaker.org), as well as several other Mozilla Foundation applications. -## To run +## Prerequisites -``` -npm install -npm start -``` - -Make sure you configure all necessary environment variables (see below) before running. If you simply want the defaults set up for local development, you can use: +- [Node](https://nodejs.org) and NPM, [installation](https://github.com/nodejs/node-v0.x-archive/wiki/Installing-Node.js-via-package-manager) +- [Postgres](http://www.postgresql.org/), [installation](http://www.postgresql.org/download/) -``` -$> cp sample.env .env -``` - -Once, after cloning the repo but before running the code. +## Up and Running +1. Fork and clone this repository +2. Navigate to the directory of the repository, e.g. `cd id.webmaker.org` +3. `npm install` to install dependencies +4. Set configuration variables, by default `cp sample.env .env` or `copy sample.env .env` on Windows +5. `npm start` +6. Navigate your browser to [`http://localhost:1234`](http://localhost:1234) ## Tests @@ -39,21 +40,11 @@ Simply add it to the folder containing your component. The browser test command ## Environment -We haven't yet added any utilities to help load environment variables; you can do it yourself by typing in the following in your terminal: +This project requires several environment variables be configured before it is able to run. It uses a library called [`habitat`](https://github.com/brianloveswords/habitat) to load configuration from a `.env` file, as well as process and cli configuration. -e.g. -``` -export HOST=0.0.0.0 -export PORT=1234 -export LOGINAPI=https://user:password@login.webmaker.org -export COOKIE_SECRET=topSecretPasswordForEncryptingCookies -export SECURE_COOKIES=true -export URI=https://id.webmaker.org -export GA_TRACKING_ID='UA-000000-01' -export GA_DEBUG='on' -export OPTIMIZELY_ID='206878104' -export OPTIMIZELY_ACTIVE='yes' -``` +A [`sample.env` file](https://github.com/mozilla/id.webmaker.org/blob/develop/sample.env) is included with this repository. Create a copy of `sample.env` named `.env` to use the default configuration. See the "Up and Running" section above for more instructions on how to do this. + +You can customize these variables by editing the `.env` file in the root directory of the repository. You can configure the following environment variables: |