1
1
[ ![ CircleCI] ( https://circleci.com/gh/topcoder-platform/admin-app.svg?style=svg )] ( https://circleci.com/gh/topcoder-platform/admin-app )
2
-
3
2
# support-admin-app
4
-
5
3
Support application
6
4
7
5
Internal application used to administer specific support tasks related to the Topcoder platform.
@@ -14,7 +12,7 @@ Internal application used to administer specific support tasks related to the To
14
12
15
13
## Installation
16
14
17
- To install npm dependencies run:
15
+ To install npm dependencies run:
18
16
19
17
> npm install
20
18
@@ -26,61 +24,60 @@ it defaults to the `dev` environment if BUILD_ENV is empty.
26
24
27
25
The following configuration parameters are available:
28
26
29
- | Name | Description |
30
- | ------------------------------- | ---------------------------------------------------------------------------------------------- |
31
- | API_URL | URL of the topcoder API |
32
- | ADMIN_TOOL_URL | URL of the admin tool API |
33
- | API_VERSION_PATH | Version of the API |
34
- | COOKIES_SECURE | If true the cookies set by this App will only be transmitted over secure protocols like https. |
35
- | AUTH_URL | Url of Topcoder auth form |
36
- | ACCOUNTS_CONNECTOR_URL | Url to TC account connector |
37
- | JWT_V3_NAME | jwt V3 cookie name |
38
- | JWT_V2_NAME | jwt V2 cookie name |
39
- | OAUTH2_TOKEN_NAME | OAuth2 token name |
40
- | OAUTH2_TOKEN_EXPIRETIME_TAGNAME | OAuth2 token expire time tag name |
41
- | SPIGIT_API_URL | SPIGIT api base url |
42
- | SPIGIT_API_VERSION_PATH | SPIGIT api version path |
43
- | GROUP_V5_API_URL | URL of the v5 Groups API |
44
- | LOOKUP_V5_API_URL | URL of the v5 Devices API |
45
- | TERMS_V5_API_URL | URL of the v5 Terms API |
46
- | CHALLENGES_V5_API_URL | URL of the v5 Challenges API |
47
- | RESOURCE_V5_API_URL | URL of the v5 Resources API |
48
- | AGREE_FOR_DOCUSIGN_TEMPLATE | UUID from Database of the ` "DocuSign Template" ` Agreeable type |
49
- | AGREE_ELECTRONICALLY | UUID from Database of the ` Electronically ` Agreeable Type |
50
- | DEFAULT_TERMS_TYPE_ID | The default terms type id |
51
- | CONNECT_URL | URL of Topcoder Connect |
52
- | DIRECT_URL | URL of Topcoder Direct |
53
- | WORK_MANAGER_URL | URL of Topcoder Work Manager |
54
- | ONLINE_REVIEW_URL | URL of Topcoder Online Review |
55
- | FORUMS_API_ENDPOINT | URL of Vanilla Forum |
56
- | FORUMS_API_TOKEN | Vanilla Forum API Access Token |
27
+ | Name | Description |
28
+ | --------------------------| ---------------------------------|
29
+ | API_URL | URL of the topcoder API |
30
+ | ADMIN_TOOL_URL | URL of the admin tool API |
31
+ | API_VERSION_PATH | Version of the API |
32
+ | COOKIES_SECURE | If true the cookies set by this App will only be transmitted over secure protocols like https. |
33
+ | AUTH_URL | Url of Topcoder auth form |
34
+ | ACCOUNTS_CONNECTOR_URL | Url to TC account connector |
35
+ | JWT_V3_NAME | jwt V3 cookie name |
36
+ | JWT_V2_NAME | jwt V2 cookie name |
37
+ | OAUTH2_TOKEN_NAME | OAuth2 token name |
38
+ | OAUTH2_TOKEN_EXPIRETIME_TAGNAME | OAuth2 token expire time tag name |
39
+ | SPIGIT_API_URL | SPIGIT api base url |
40
+ | SPIGIT_API_VERSION_PATH | SPIGIT api version path |
41
+ | GROUP_V5_API_URL | URL of the v5 Groups API |
42
+ | LOOKUP_V5_API_URL | URL of the v5 Devices API |
43
+ | TERMS_V5_API_URL | URL of the v5 Terms API |
44
+ | CHALLENGES_V5_API_URL | URL of the v5 Challenges API |
45
+ | RESOURCE_V5_API_URL | URL of the v5 Resources API |
46
+ | MEMBER_V5_API_URL | URL of the v5 Member API |
47
+ | AGREE_FOR_DOCUSIGN_TEMPLATE | UUID from Database of the ` "DocuSign Template" ` Agreeable type |
48
+ | AGREE_ELECTRONICALLY | UUID from Database of the ` Electronically ` Agreeable Type |
49
+ | DEFAULT_TERMS_TYPE_ID | The default terms type id |
50
+ | CONNECT_URL | URL of Topcoder Connect |
51
+ | DIRECT_URL | URL of Topcoder Direct |
52
+ | WORK_MANAGER_URL | URL of Topcoder Work Manager |
53
+ | ONLINE_REVIEW_URL | URL of Topcoder Online Review |
54
+
57
55
58
56
## Start the Application
59
57
60
58
Simply execute the following command to start the app in development mode (with browsersync)
61
-
62
59
```
63
60
npm install
64
61
npm run dev
65
-
66
- Application will be hosted and running at http://local.topcoder-dev.com :3000.
62
+ ```
63
+ Application will be hosted and running at http://localhost :3000 .
67
64
68
65
## Execute E2E Tests
69
66
70
67
Before executing the end-to-end (e2e) protractor tests, these environment variables should be set:
71
68
72
- | Name | Description | Default Value |
73
- | --------- | --------------------------------------------------- | ------------------------------------------------------------------------ --- |
69
+ | Name | Description | Default Value |
70
+ | --- | --- | --- |
74
71
| BUILD_ENV | Deployment configuration to be tested by e2e tests. | See [ Configuration] ( #configuration ) for possible values. Defaults to ` dev ` . |
75
- | TEST_PORT | Port from which to serve the app for e2e tests. | Defaults to `3000`. |
72
+ | TEST_PORT | Port from which to serve the app for e2e tests. | Defaults to ` 3000 ` . |
76
73
77
- `npm test`
74
+ ``` npm test `` `
78
75
79
76
## Fallback instruction in case the npm scripts fail
80
77
81
78
### Install global dependencies
82
79
83
- `npm install -g [email protected] `
80
+ ``` npm install -g [email protected] `` `
84
81
85
82
### Install project dependencies
86
83
@@ -90,14 +87,15 @@ npm install
90
87
91
88
### Start the Application
92
89
93
- `gulp serve`
90
+ ``` gulp serve `` `
94
91
95
92
### Build the Application
96
93
97
- `gulp build`
94
+ ``` gulp build `` `
98
95
99
96
### Execute E2E Tests
100
97
101
- `gulp protractor`
98
+ ``` gulp protractor ```
99
+
102
100
103
101
Update to Push CI
0 commit comments