support-admin-app
Support application
Internal application used to administer specific support tasks related to the Topcoder platform.
Software Requirements
- node.js v6 (not later)
- npm v3
- Google Chrome browser version >= 55.0.2883.0
Installation
To install npm dependencies run:
npm install
Configuration
The configuration is provided in config.json in the base directory.
It contains four environments (local, dev, qa, prod) which are controlled by the BUILD_ENV environment variable,
it defaults to the dev environment if BUILD_ENV is empty.
The following configuration parameters are available:
| Name | Description |
|---|---|
| API_URL | URL of the topcoder API |
| ADMIN_TOOL_URL | URL of the admin tool API |
| API_VERSION_PATH | Version of the API |
| COOKIES_SECURE | If true the cookies set by this App will only be transmitted over secure protocols like https. |
| AUTH_URL | Url of Topcoder auth form |
| ACCOUNTS_CONNECTOR_URL | Url to TC account connector |
| JWT_V3_NAME | jwt V3 cookie name |
| JWT_V2_NAME | jwt V2 cookie name |
| OAUTH2_TOKEN_NAME | OAuth2 token name |
| OAUTH2_TOKEN_EXPIRETIME_TAGNAME | OAuth2 token expire time tag name |
| SPIGIT_API_URL | SPIGIT api base url |
| SPIGIT_API_VERSION_PATH | SPIGIT api version path |
| GROUP_V5_API_URL | URL of the v5 Groups API |
| REVIEW_SERVICE_V5_API_URL | URL of the v3 ap-review-microservice API |
| LOOKUP_V5_API_URL | URL of the v5 Devices API |
| TERMS_V5_API_URL | URL of the v5 Terms API |
| CHALLENGES_V5_API_URL | URL of the v5 Challenges API |
| RESOURCE_V5_API_URL | URL of the v5 Resources API |
| MEMBER_V5_API_URL | URL of the v5 Member API |
| AGREE_FOR_DOCUSIGN_TEMPLATE | UUID from Database of the "DocuSign Template" Agreeable type |
| AGREE_ELECTRONICALLY | UUID from Database of the Electronically Agreeable Type |
| DEFAULT_TERMS_TYPE_ID | The default terms type id |
| CONNECT_URL | URL of Topcoder Connect |
| DIRECT_URL | URL of Topcoder Direct |
| WORK_MANAGER_URL | URL of Topcoder Work Manager |
| ONLINE_REVIEW_URL | URL of Topcoder Online Review |
Start the Application
Simply execute the following command to start the app in development mode (with browsersync)
npm install
npm run devApplication will be hosted and running at http://localhost:3000.
Execute E2E Tests
Before executing the end-to-end (e2e) protractor tests, these environment variables should be set:
| Name | Description | Default Value |
|---|---|---|
| BUILD_ENV | Deployment configuration to be tested by e2e tests. | See Configuration for possible values. Defaults to dev. |
| TEST_PORT | Port from which to serve the app for e2e tests. | Defaults to 3000. |
npm test
Fallback instruction in case the npm scripts fail
Install global dependencies
npm install -g gulp@3.8.10
Install project dependencies
npm installStart the Application
gulp serve
Build the Application
gulp build
Execute E2E Tests
gulp protractor
Update to Push CI