Skip to content

Commit

Permalink
fix: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kobenguyent committed Feb 8, 2024
1 parent 58b56f9 commit d2a300f
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
15 changes: 14 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,25 @@

1. clone repository
2. Run `npm install`
3. Run `npm run build` (this is required for a fresh start)
3. Run `npm run build` (this is required for a fresh start)

We need frontend and backend server to be started for this application.

Frontend server compiles assets, while backend server communicates with CodeceptJS and processes HTTP and WebSocket requests. HTTP is used to send commands from client to CodeceptJS, and websockets are used to send notifications from CodeceptJS to application.

Note: if you error when building the app, just set this `NODE_OPTIONS=--openssl-legacy-provider` in your terminal

```
> @codeceptjs/[email protected] build
> vue-cli-service build
⠹ Building for production...Error: error:0308010C:digital envelope routines::unsupported
at new Hash (node:internal/crypto/hash:69:19)
at Object.createHash (node:crypto:133:10)
```


Both servers must be executed for development:

### Launch application in Electron mode:
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
"version": "0.7.3",
"license": "MIT",
"scripts": {
"serve": "NODE_OPTIONS=--openssl-legacy-provider vue-cli-service serve",
"build": "NODE_OPTIONS=--openssl-legacy-provider vue-cli-service build",
"serve": "vue-cli-service serve",
"build": "vue-cli-service build",
"lint": "vue-cli-service lint --fix && vue-cli-service lint lib/** --fix",
"app": "node bin/codecept-ui.js --app -c node_modules/@codeceptjs/examples",
"backend": "node bin/codecept-ui.js -c node_modules/@codeceptjs/examples/codecept.conf.js",
Expand Down

0 comments on commit d2a300f

Please sign in to comment.