- Notifications
You must be signed in to change notification settings - Fork39
Package for sharing#76
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
7 commits Select commitHold shift + click to select a range
6db7d1f
cleanup the README with setup instructions
ShMcK252fd05
fix up vscode ignored files
ShMcK0bb15c3
cleanup ts build
ShMcK41bf091
add install extension demo directions
ShMcK927f48e
cleanup dev build
ShMcKa854eb2
fix issue with dotenv in build
ShMcKfb41b4d
update install extension docs
ShMcKFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
25 changes: 19 additions & 6 deletions.vscodeignore
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,26 @@ | ||
## Common | ||
.gitignore | ||
## Docs | ||
DEV.md | ||
## VSCode | ||
.vscode/** | ||
.vscode-test/** | ||
vsc-extension-quickstart.md | ||
*.vsix | ||
## Dev Folders | ||
src/** | ||
web-app/** | ||
.env | ||
.prettierrc.js | ||
jest.config.js | ||
## TypeScript | ||
**/tsconfig.json | ||
**/tslint.json | ||
**/*.ts | ||
## Tests | ||
build/test/** |
64 changes: 64 additions & 0 deletionsDEV.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# Setup | ||
## Development | ||
Run the postgres db and api server. | ||
Setup the extension environmental variables. | ||
/src/.env | ||
``` | ||
LOG=true #show hide debugging logs | ||
``` | ||
Setup the web app environmental variables. | ||
/web-app/.env.local | ||
``` | ||
REACT_APP_DEBUG=true # show/hide web debugger | ||
REACT_APP_GQL_URI=http://localhost:4000/graphql | ||
``` | ||
Run `npm run build`. Press F5 to open a new development window. | ||
Open the tutorial using `cmd+shift+p` on mac, and select the action `coderoad.start`. | ||
## Supported Programming Languages | ||
To support a new programming language, the test runner needs to support a format called TAP (https://testanything.org/). | ||
Some test frameworks can be modified to use tap, see a list of TAP reporters: https://github.com/sindresorhus/awesome-tap#reporters. | ||
### JavaScript | ||
##### Jest | ||
```json | ||
{ | ||
"scripts": { | ||
"test": "jest" | ||
}, | ||
"devDependencies": { | ||
"jest-tap-reporter": "1.9.0" | ||
}, | ||
"jest": { | ||
"reporters": ["jest-tap-reporter"] | ||
} | ||
} | ||
``` | ||
## Install Extension Demo | ||
1. Copy the `CodeRoad.vsix` file locally | ||
2. Select the extensions logo from the left hand panel | ||
3. In the top right of the panel, select the three dots “more” dropdown. | ||
1. Choose “Install from VSIX…” | ||
2. Select the `CodeRoad.vsix` file and press “Install” | ||
4. Reload the VSCode editor (Ctrl/Cmd + Shift + P, run "Reload Window") | ||
5. Open up a new folder directory in VSCode and run the extension `coderoad:start` | ||
## Known Issues | ||
There are no known issues at this time. |
65 changes: 3 additions & 62 deletionsREADME.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletionspackage-lock.json
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
15 changes: 5 additions & 10 deletionspackage.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletionsrc/environment.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
55 changes: 27 additions & 28 deletionstsconfig.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,29 @@ | ||
{ | ||
"compilerOptions": { | ||
"module": "commonjs", | ||
"target": "es2018", | ||
"outDir": "build", | ||
"lib": ["es2018", "dom"], | ||
"sourceMap": true, | ||
"rootDir": "src", | ||
"baseUrl": "src", | ||
"strict": true /* enable all strict type-checking options */, | ||
/* Additional Checks */ | ||
"forceConsistentCasingInFileNames": true, | ||
"noImplicitReturns": true, | ||
"noImplicitThis": true, | ||
"noImplicitAny": true, | ||
"strictNullChecks": true, | ||
"suppressImplicitAnyIndexErrors": true, | ||
"noUnusedLocals": false, | ||
"experimentalDecorators": true, | ||
"emitDecoratorMetadata": true, | ||
"paths": { | ||
"typings": ["../typings/index.d.ts"], | ||
"typings/graphql": ["../typings/graphql.d.ts"] | ||
}, | ||
"allowJs": true, | ||
"removeComments": true | ||
}, | ||
"exclude": ["node_modules", ".vscode-test", "build", "resources", "web-app", "*.js", "*.test.ts"] | ||
} |
1 change: 0 additions & 1 deletionweb-app/package.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
21 changes: 8 additions & 13 deletionsweb-app/src/environment.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,10 @@ | ||
// validate .env | ||
//const requiredKeys = ['REACT_APP_GQL_URI'] | ||
//for (const required of requiredKeys) { | ||
// if (!process.env[required]) { | ||
// throw new Error(`Missing Environmental Variables: ${required}`) | ||
// } | ||
//} | ||
export const GQL_URI: string= process.env.REACT_APP_GQL_URI || 'https://33mf420q4m.execute-api.us-west-2.amazonaws.com/stage/api-stage' | ||
export const DEBUG: boolean = (process.env.REACT_APP_DEBUG || '').toLowerCase() === 'true' |
9 changes: 8 additions & 1 deletionweb-app/tsconfig.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
18 changes: 8 additions & 10 deletionsweb-app/tsconfig.paths.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,10 @@ | ||
{ | ||
"compilerOptions": { | ||
"paths": { | ||
"typings": ["../../typings/index.d.ts"], | ||
"typings/graphql": ["../../typings/graphql.d.ts"] | ||
}, | ||
"allowSyntheticDefaultImports": true | ||
}, | ||
"exclude": ["node_modules", "build", "scripts", "jest", "public"] | ||
} |
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.