|
1 | 1 | #Setup |
2 | 2 |
|
3 | | -##Development |
4 | | - |
5 | | -Run the postgres db and api server. |
6 | | - |
7 | | -Setup the extension environmental variables. |
8 | | - |
9 | | -/src/.env |
10 | | - |
11 | | -``` |
12 | | -LOG=true #show hide debugging logs |
13 | | -``` |
14 | | - |
15 | | -Setup the web app environmental variables. |
16 | | - |
17 | | -/web-app/.env.local |
18 | | - |
19 | | -``` |
20 | | -REACT_APP_DEBUG=true # show/hide web debugger |
21 | | -REACT_APP_GQL_URI=http://localhost:4000/graphql |
22 | | -``` |
23 | | - |
24 | | -Run`npm run build`. Press F5 to open a new development window. |
25 | | - |
26 | | -Open the tutorial using`cmd+shift+p` on mac, and select the action`coderoad.start`. |
27 | | - |
28 | | -##Supported Programming Languages |
29 | | - |
30 | | -To support a new programming language, the test runner needs to support a format called TAP (https://testanything.org/). |
31 | | - |
32 | | -Some test frameworks can be modified to use tap, see a list of TAP reporters:https://github.com/sindresorhus/awesome-tap#reporters. |
33 | | - |
34 | | -###JavaScript |
35 | | - |
36 | | -#####Jest |
37 | | - |
38 | | -```json |
39 | | -{ |
40 | | -"scripts": { |
41 | | -"test":"jest" |
42 | | - }, |
43 | | -"devDependencies": { |
44 | | -"jest-tap-reporter":"1.9.0" |
45 | | - }, |
46 | | -"jest": { |
47 | | -"reporters": ["jest-tap-reporter"] |
48 | | - } |
49 | | -} |
50 | | -``` |
51 | | - |
52 | 3 | ##Install Extension Demo |
53 | 4 |
|
54 | | -1. Copy the`CodeRoad.vsix` file locally |
55 | | -2. Select the extensions logo from the left hand panel |
56 | | -3. In the top right of the panel, select the three dots “more” dropdown. |
| 5 | +1. Copy the`CodeRoad.vsix` file locally. |
| 6 | +2. In the top right of the panel, select the three dots “more” dropdown. |
57 | 7 | 1. Choose “Install from VSIX…” |
58 | 8 | 2. Select the`CodeRoad.vsix` file and press “Install” |
59 | | -4. Reload the VSCode editor (Ctrl/Cmd + Shift + P, run "Reload Window") |
60 | | -5. Open up a new folder directory in VSCode and run the extension`coderoad:start` |
| 9 | +3. Reload the VSCode editor (Ctrl/Cmd + Shift + P, run "Reload Window") |
| 10 | +4. Open up a new folder directory in VSCode and run the extension`coderoad:start` |
61 | 11 |
|
62 | 12 | ##Known Issues |
63 | 13 |
|
|