diff --git a/README.md b/README.md index be88de78e..e29c6b759 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,26 @@ # Badgr UI -An Angular 2 based front end for Badgr-server. Uses TypeScript with ES6 style module loading and a webpack-based build process. +An Angular 2 based front end for Badgr-server. Uses TypeScript with ES6 style module loading and a webpack-based build process. This is the browser UI for [badgr-server](https://github.com/concentricsky/badgr-server-prerelease). ### About the Badgr Project -Badgr was developed by Concentric Sky, starting in 2015 to serve as an open source reference implementation of the Open Badges Specification. It provides functionality to issue portable, verifiable Open Badges as well as to allow users to manage badges they have been awarded by any issuer that uses this open data standard. Since 2015, Badgr has grown to be used by hundreds of educational institutions and other people and organizations worldwide. +[Badgr](https://badgr.org) was developed by Concentric Sky, starting in 2015 to serve as an open source reference implementation of the Open Badges Specification. It provides functionality to issue portable, verifiable Open Badges as well as to allow users to manage badges they have been awarded by any issuer that uses this open data standard. Since 2015, Badgr has grown to be used by hundreds of educational institutions and other people and organizations worldwide. ## Install Instructions (for developers) ## System-wide prerequisites (OS X): -* node and npm: see https://docs.npmjs.com/getting-started/installing-node +* node and npm: see [Installing Node](https://docs.npmjs.com/getting-started/installing-node) +* (optional) [nvm](https://github.com/creationix/nvm) - node version manager: In order to work with multiple projects on your development environment that have diverse dependencies, you may want to have multiple versions of node installed. NVM allows you to do this. If this applies to you, consider using nvm to manage your node environments. `nvm use` in a project directory with a `.nvmrc` file will use the recommended node version. Make sure to `nvm use [VERSION]` the correct version before any `npm install` steps. ### Install and configure project -* Install node/npm version using nvm: `nvm install && nvm use` -* Install project-specific node dependencies. `npm install` +* Install and run [badgr-server](https://github.com/concentricsky/badgr-server-prerelease), the API that this application connects to. +* Install node/npm version using nvm: `nvm use && nvm install` +* Install project-specific node dependencies. `npm install` ### Run project in your browser Start webpack in dev mode: `npm run server` -Badgr should now be loaded in your browser. If not, navigate to http://localhost:4000 +Badgr should now be loaded in your browser. If your browser didn't start automatically, navigate to http://localhost:4000 ### Run Tests @@ -43,14 +45,5 @@ Build the packaged files for deployment with `npm run build:prod` Run the tests with `npm run test:ci` -All files in `dist` constitute the build artifact. A config.js must be included as well for the app to function. +All files in `dist` constitute the build artifact. A config.js must be included as well for the app to function. An example can be found in `src/configs/config.local.js` - -### Release Branching and Tagging - -Badgr UI release branches follow the `release/vA.B.x` format, with a separate branch for each minor version, and a -tag for each patch release (e.g. `v2.3.1`). - -To create a release branch, simply run e.g. `git checkout -b release/v6.5.x` - -To create a tag for a specific version, including the first tag, run `node tag-branch.js` which will also push the tag \ No newline at end of file