8 | 
8 |
9 | ## Prerequisites
10 |
11 | * node: ">=4.2.0"
12 | * npm: ">=3.0.0"
13 | * Github access token
14 |
15 | ## Overview
16 |
17 | This is a central place where you can view
18 |
19 | * demos of all the components under the organizations you specified
20 | * documentations of your components
21 | * dependencies your components have (dependencies)
22 | * other components/applications that depend on your components (usages)
23 |
24 | There are 2 ways the components can update dynamically:
25 |
26 | 1. Add github hooks to send POST requests to `/api/update/{org}/{repoName}` when a new tag is created
27 | 2. Enable `./server/poll` plugin to set up cron job that sends the POST requests every day
28 |
29 | After the server receives the POST request, it will fetch the `package.json` file under `yourGithubUrl/org/repoName`,
30 | update [data/orgs.json] and `data/{org}/{repoName}.json` files. If there is a newer version, it will try to download the
31 | new component through npm ([scripts/install-module.sh]) after a waiting period, babel transpile, and webpack the demo module ([scripts/post-install-module.sh]).
32 |
33 | To make the server update immediately or force an update, add a url parameter to the POST request, `/api/update/{org}/{repoName}?updateNow=1`.
34 |
35 | This post processing script works well with all electrode components (meaning components using our [archetype]). If you have non-electrode components, you can modify your [scripts/post-install-module.sh]. See our [wiki] page for more details.
36 |
37 | ## Config
38 |
39 | ```js
40 | // config/default.json
41 | {
42 | "plugins": {
43 | "./server/poll": {
44 | "options": {
45 | "enable": true
46 | }
47 | }
48 | },
49 |
50 | "githubApi": {
51 | "version": "3.0.0",
52 | "pathPrefix": "/api/v3",
53 | "protocol": "https",
54 | "host": "github.com"
55 | },
56 |
57 | "ORGS": [
58 | // org/user names under which components will be included in the explorer
59 | // for example, put ["xxx", "yyy"] to include every repo under github.com/xxx and github.com/yyy
60 | ],
61 |
62 | "REPOS_USAGE_INCLUDE": [
63 | // consumers need to contain one of these substrings to be included in usages
64 | // for example, put ["react"] so consumers named /*react*/ will be included in usages
65 | ],
66 |
67 | "REPOS_USAGE_EXCLUDE": [
68 | // consumers containing any of these substrings won't be included in usages
69 | // for example, put ["training"] so consumers named /*training*/ will be excluded in usages
70 | ],
71 |
72 | "MODULE_PREFIXES_INCLUDE": [
73 | // only module names beginning with one of these strings will be included in dependencies
74 | // for example, put ["react"] so only modules with name starting with "react" will be included in dependencies
75 | ],
76 |
77 | "NPM_WAITING_TIME": 300000, // wait for 5 minutes before `npm install`
78 |
79 | "GHACCESS_TOKEN_NAME": "GHACCESS_TOKEN" // github token variable name, your token would be accessible via `process.env["GHACCESS_TOKEN"]`
80 | }
81 | ```
82 |
83 | ## Start server
84 |
85 | First install dependencies
86 | ```sh
87 | npm i
88 | ```
89 |
90 | Export github access token or set it as an environment variable
91 | ```sh
92 | export GHACCESS_TOKEN=YOUR_GITHUB_TOKEN
93 | ```
94 |
95 | For development mode
96 | ```sh
97 | gulp dev
98 | ```
99 | or
100 | ```sh
101 | GHACCESS_TOKEN=YOUR_GITHUB_TOKEN gulp dev
102 | ```
103 |
104 | For production mode
105 | ```sh
106 | gulp build
107 | ```
108 | and
109 | ```sh
110 | NODE_ENV=production node .
111 | ```
112 | or
113 | ```sh
114 | GHACCESS_TOKEN=YOUR_GITHUB_TOKEN NODE_ENV=production node .
115 | ```
116 |
117 | ## Deploy
118 |
119 | Since this is an electrode app, it can be deployed the same way as any other electrode app. Just remember to set your github token as an environment variable.
120 |
121 | ## Learn more
122 |
123 | Wish to learn more? Check our [wiki] page!
124 |
125 | Built with :heart: by [Team Electrode](https://github.com/orgs/electrode-io/people) @WalmartLabs.
126 |
127 | [archetype]: https://github.com/electrode-io/electrode-archetype-react-component
128 | [data/orgs.json]: https://github.com/electrode-io/electrode-explorer/blob/master/data/orgs.json
129 | [scripts/install-module.sh]: https://github.com/electrode-io/electrode-explorer/blob/master/scripts/install-module.sh
130 | [scripts/post-install-module.sh]: https://github.com/electrode-io/electrode-explorer/blob/master/scripts/post-install-module.sh
131 | [wiki]: https://github.com/electrode-io/electrode-explorer/wiki
132 |
133 |
--------------------------------------------------------------------------------
/server/webapp/index.js:
--------------------------------------------------------------------------------
1 | "use strict";
2 |
3 | const _ = require("lodash");
4 | const Promise = require("bluebird");
5 | const fs = require("fs");
6 | const Path = require("path");
7 | const assert = require("assert");
8 |
9 | const HTTP_ERROR_500 = 500;
10 | const HTTP_REDIRECT = 302;
11 |
12 | /**
13 | * Load stats.json which is created during build.
14 | * The file contains bundle files which are to be loaded on the client side.
15 | *
16 | * @param {string} statsFilePath - path of stats.json
17 | * @returns {Promise.