Skip to content

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jan 19, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
cleanup the README with setup instructions
  • Loading branch information
ShMcK committed Jan 18, 2020
commit 6db7d1ff4de7ad9ee6ee4b611d2d91c6cfa1989c
65 changes: 3 additions & 62 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,66 +12,7 @@ Requires:
- Git
- Node 10+

## Development
## Run

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
REACT_APP_GQL_AUTH_TOKEN={YOUR_API_AUTH_TOKEN}
```

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`.

## Extension Settings

Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.

For example:

This extension contributes the following settings:

- `coderoad.start`: starts the extension

## 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"]
}
}
```

## Known Issues

There are no known issues at this time.
1. Open the command prompt: `cmd/ctrl + shift + p`
2. Search for and run `coderoad:start`
54 changes: 54 additions & 0 deletions SETUP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# 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"]
}
}
```

## Known Issues

There are no known issues at this time.