Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commitab6bc8f

Browse files
committed
update dev docs
Signed-off-by: shmck <shawn.j.mckay@gmail.com>
1 parent57625e1 commitab6bc8f

File tree

4 files changed

+782
-3
lines changed

4 files changed

+782
-3
lines changed

‎README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,25 @@ See an [interactive visualization](https://coderoad.github.io/coderoad-visual/)
4646

4747
Tutorials can be edited directly as markdown on Github.
4848

49+
##Development
50+
51+
To run the extension locally:
52+
53+
- copy environmental variables from`/web-app/.env.example` as`/web-app/.env`
54+
- install dependencies with`yarn install-all`
55+
- build the extension with`yarn build`
56+
- open the extension with the vscode extension debugger by pressing F5. In the new window, open CodeRoad.
57+
58+
To test a packaged build locally:
59+
60+
- if on Mac, ensure you have[VSCode command line tools](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line) installed
61+
- run`yarn package`. It will build the extension and install it locally.
62+
- open a new vscode window and launch the new version of CodeRoad
63+
4964
##Contributing
5065

66+
CodeRoad is an ambitious project, we're always looking for contributors :)
67+
5168
See[CONTRIBUTING.md](./CONTRIBUTING.md).
5269

5370
##License

‎package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@
2626
"scripts": {
2727
"build":"./scripts/build.sh",
2828
"postinstall":"node ./node_modules/vscode/bin/install",
29-
"install-all":"yarn &&cdweb-app && yarn",
29+
"install-all":"yarn &&yarn --cwdweb-app",
3030
"lint":"eslint src/**/*ts",
3131
"package":"./scripts/package.sh",
32-
"storybook":"cdweb-app && npm run storybook",
32+
"storybook":"yarn --cwdweb-app storybook",
3333
"test":"jest",
3434
"watch":"tsc -watch -p ./"
3535
},

‎scripts/build.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ tsc -p ./
1212

1313
# build web app
1414
cd web-app
15-
npm run build
15+
yarn build
1616
cd ..
1717

1818
# For Windows build: switch the next 2 lines

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp