diff --git a/README.md b/README.md index 1b98e209e..3c1af32af 100644 --- a/README.md +++ b/README.md @@ -44,8 +44,8 @@ npm install -g @angular/cli ## To build for development -**in a terminal window** -> npm start -**in another terminal window** -> npm run electron:serve +- **in a terminal window** -> npm start +- **in another terminal window** -> npm run electron:serve Voila! You can use your Angular + Electron app in a local development environment with hot reload ! @@ -53,16 +53,31 @@ The application code is managed by `main.js`. In this sample, the app runs with The Angular component contains an example of Electron and NodeJS native lib import. See [Use NodeJS Native libraries](#use-nodejs-native-libraries) charpter if you want to import other native libraries in your project. You can desactivate "Developer Tools" by commenting `win.webContents.openDevTools();` in `main.js`. -## To build for production +## Browser mode + +Maybe you want to execute the application in the browser ? You can do it with `npm run start:web`. +Note that you can't use Electron or NodeJS native libraries in this case. Please check `providers/electron.service.ts` to watch how conditional import of electron/Native libraries is done. -* Using development variables (environments/index.ts) : `npm run electron:dev` +## To build for production -* Using production variables (environments/index.prod.ts) : `npm run electron:prod` +- Using development variables (environments/index.ts) : `npm run electron:dev` +- Using production variables (environments/index.prod.ts) : `npm run electron:prod` Your built files are in the /dist folder. +## Execute E2E tests + +You can find end-to-end tests in /e2e folder. + +Before executing e2e scripts, you may need to update drivers libraries : `npm run pree2e` + +You can now execute tests with the command lines below : +- **in a terminal window** -> First, start a web server on port 4200 : `npm run start:web` +- **in another terminal window** -> Then, execute Protractor : `npm run e2e` + ## Included Commands +- `npm run start:web` - Execute the app in the brower - `npm run electron:linux` - builds your application and creates an app consumable on linux systems. - `npm run electron:windows` - On a Windows OS, builds your application and creates an app consumable in windows 32/64 bit systems. - `npm run electron:mac` - On a MAC OS, builds your application and generates a `.app` file of your application that can be run on Mac.