1 | [![Build Status](https://travis-ci.org/webgme/user-management-page.svg?branch=master)](https://travis-ci.org/webgme/user-management-page)
|
2 | [![Version](https://badge.fury.io/js/webgme-user-management-page.svg)](https://www.npmjs.com/package/webgme-user-management-page)
|
3 | [![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](https://opensource.org/licenses/MIT)
|
4 |
|
5 | ### A webpage for users to manage their webgme account and projects.
|
6 | `webgme-user-management-page` runs as a dependency of [webgme](https://github.com/webgme/webgme) and is available at `<host>/profile`
|
7 | when [authentication is enabled](https://github.com/webgme/webgme/wiki/Users-and-Authentication). The purpose is to
|
8 | allow for registration and login, project authorization of other users/organizations, and creation of
|
9 | organizations as well as member/admin control for those organizations.
|
10 |
|
11 | For instructions on webgme authentication and user-management see [this demo on youtube](https://www.youtube.com/watch?v=xS6_FK8kZhE).
|
12 |
|
13 | Since webgme [v2.15.0](https://github.com/webgme/webgme/releases/) you can easily fork and modify this page to fit your needs
|
14 | and replace the mounted user-management-page point to your customization.
|
15 |
|
16 | ![WebGME-User-Management-Page](images/landing-page.png "Web-app is based on AdminLTE")
|
17 |
|
18 | ## Developers
|
19 | #### Steps to run as an external REST router within WebGME
|
20 |
|
21 | WebGME requires [NodeJS](https://nodejs.org/) (0.12 <= version, CI tests are performed on versions 4.x, 6.x) and [MongoDB](https://www.mongodb.com/) (version >= 2.6) installed on the host system (the server).
|
22 | In addition the npm installation requires [Git](https://git-scm.com) to be installed and available in PATH.
|
23 |
|
24 | 1. Ensure dependencies are installed and mongodb is running on default port
|
25 | 2. Install dependencies `npm install`
|
26 | 3. Set environment variable for webpack: `set NODE_ENV=development` linux: `NODE_ENV=development`
|
27 | 3. Run webpack `npm run webpack`
|
28 | 4. Start (webgme) server `npm start` (`NODE_ENV` should not be set)
|
29 | 5. From a browser visit `http://localhost:8888/usermanagement/`
|
30 |
|
31 |
|
32 | #### Webpack file listener
|
33 | To build client side bundle on file changes invoke
|
34 | ```
|
35 | webpack -w
|
36 | ```
|
37 | or if not installed globally
|
38 | ```
|
39 | npm run webpack -- -w
|
40 | ```
|
41 |
|
42 | ##### Publish
|
43 | Delete all unversioned files in `/dist/**`
|
44 | ```
|
45 | npm prune
|
46 | npm install
|
47 | npm version 0.3.0 -m "Release %s"
|
48 | git push origin master
|
49 | git checkout v0.3.0
|
50 | git push origin v0.3.0
|
51 | npm publish ./
|
52 | ```
|