This project was bootstrapped with Create React App.
You have two ways to run the app. First is direct on your host system. Just follow the commands below to do this.
Second one is to use docker. It's preffered way, because there is no certainty
that your host system will have proper version of node.js and other dependencies
(Electron depends on many libs that are hosted on dev machine).
If you want to use docker way, please make sure you have newest docker installed
(tested on 18.09.1-ce).
Then, follow the command in next steps, but prefix all of them by this:
docker-compose run --rm web ...E.g.
docker-compose run --rm web yarn
docker-compose run --rm web yarn start
docker-compose run --rm web yarn start-electron
To avoid repetition of docker-compose run --rm I advice to use system alias, e.g. dcrun that cover this prefix.
To install dependencies just call yarn: yarn
In the project directory, you can run:
Runs the app server in the development mode. It will serve the content on http://localhost:3000 so it can be load by electron build.
After run the server, you should run yarn start-electron.
The app will restart if you make edits in electron main process code (src/electron/**).
The app content will reload if you make edits in electron renderer code.
You will also see any lint errors in the console.
It is possible to handle it by one command, but it's make things less clean because nature of the electron. Electron have "main" process, where it handle communication with OS and the "render" process that in our case is handled by React code. In dev mode when we run both processes separately we have better, cleaner control of the errors and app automatic reloading mechanism.
Launches the test runner in the interactive watch mode. See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
It's not ready yet for the production usage with electron.
See the section in create-react-app docs about deployment for more information.
We use tslint to lint the code, it would be useful if you install it in your IDE.
For scss linting we use sass-lint package. If you IDE support it, please install it,
it will help you to make cleaner SCSS faster.
Do general tests before pushing your code call this command:
yarn check-code
This will perform scss linting, typescript linting and unit tests.
If you won't, the CI will do it for you and you won't be able to merge you PR.
If you need access electron lib in renderer process for whatever reason, use ./src/electron-bridge.ts module.
Check the file comment for explanation why we do this.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.