Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,15 @@ node_js:
env:
global:
- CC_TEST_REPORTER_ID=0be009d55f19435b5d362efac7afcdc532945bbc13527c285135c5e7b84f4e3c
cache:
yarn: true
directories:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we still want to cache this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- node_modules
cache: npm
before_script:
- cd webnode/
- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
- chmod +x ./cc-test-reporter
- ./cc-test-reporter before-build
script:
- yarn && yarn test:coverage
- npm install
- npm run test:coverage
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You still need to install dependencies with npm ci. Might make sense to create an install step in travis so it can cache the install steps.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nvm, I see you updated it. Didn't we want to use npm ci? Also still might make sense to do that in the install step instead of script so travis can cache it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

after_script:
- ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
deploy:
Expand Down
36 changes: 16 additions & 20 deletions webnode/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@

# Webnode

The webnode script runs on oyster-enabled websites, to replace or augment ad revenue. This script will run in the browsers of visitors to the website. Files on the tangle expire and must be periodically reattached. In the process of doing the reattachment, the webnode could find PRL which the brokernode will send to the website owner's ETH address. To obtain the genesis hashes that the webnode needs to begin a treasure hunt, it will do some PoW for brokernodes to assist with in-progress file uploads.
The webnode script runs on oyster-enabled websites, to replace or augment ad revenue. This script will run in the browsers of visitors to the website. Files on the tangle expire and must be periodically reattached. In the process of doing the reattachment, the webnode could find PRL which the brokernode will send to the website owner's ETH address. To obtain the genesis hashes that the webnode needs to begin a treasure hunt, it will do some PoW for brokernodes to assist with in-progress file uploads.

## Getting Started

Expand All @@ -15,19 +14,18 @@ Clone the repo
git clone https://github.com/oysterprotocol/webnode.git
```

Modify webnode/src/config to point to development brokers, change API\_ROOT\_URL

Modify webnode/src/config to point to development brokers, change API_ROOT_URL

Install dependencies
Install dependencies

```
yarn
npm
```

Start web server

```
yarn start
npm start
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't these commands become npm run ...?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there are a few reserved words that just run without needing to add run

```

Navigate to url
Expand All @@ -41,19 +39,19 @@ Navigate to url
Run Once

```
yarn test
npm test
```

Run with watcher

```
yarn test:watch
npm run test:watch
```

Run with code coverage

```
yarn test:coverage
npm run test:coverage
```

### Coding style tests
Expand All @@ -66,18 +64,16 @@ ES Lint is configured to run on compile, you will see warnings in the console in

## Built With

* [React](https://reactjs.org/) - The web framework used
* [Redux](https://redux.js.org/) - State Management
* [IOTA](https://github.com/iotaledger/iota.lib.js/) - IOTA Core API
* [Webpack](https://webpack.js.org/) - Build tools

- [React](https://reactjs.org/) - The web framework used
- [Redux](https://redux.js.org/) - State Management
- [IOTA](https://github.com/iotaledger/iota.lib.js/) - IOTA Core API
- [Webpack](https://webpack.js.org/) - Build tools

## Project Status

* [Travis CI Builds](https://travis-ci.org/oysterprotocol/webnode) - Build Report
* [E2E Test Dashboard (Cypress)](https://www.cypress.io/) - E2E test results
* [Code Climate](https://codeclimate.com/github/oysterprotocol/webnode) - Reports code coverage, maintainability, and trends

- [Travis CI Builds](https://travis-ci.org/oysterprotocol/webnode) - Build Report
- [E2E Test Dashboard (Cypress)](https://www.cypress.io/) - E2E test results
- [Code Climate](https://codeclimate.com/github/oysterprotocol/webnode) - Reports code coverage, maintainability, and trends

## Contributing

Expand All @@ -89,4 +85,4 @@ We use [SemVer](http://semver.org/) for versioning.

## Authors

See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
3 changes: 1 addition & 2 deletions webnode/config/paths.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,8 @@ module.exports = {
appIndexJs: resolveApp("src/index.tsx"),
appPackageJson: resolveApp("package.json"),
appSrc: resolveApp("src"),
yarnLockFile: resolveApp("yarn.lock"),
testsSetup: resolveApp("src/setupTests.js"),
appNodeModules: resolveApp("node_modules"),
publicUrl: getPublicUrl(resolveApp("package.json")),
servedPath: getServedPath(resolveApp("package.json"))
servedPath: getServedPath(resolveApp("package.json")),
};
Loading