It's a chat desktop app. This README.md referenced [chentsulin/electron-react-boilerplate] https://github.com/chentsulin/electron-react-boilerplate
Electron application boilerplate based on React, Redux, React Router, Webpack, React Transform HMR for rapid application development
- Note: requires a node version >= 6 and an npm version >= 3.
- If you have installation or compilation issues with this project, please see our debugging guide
First, clone the repo via git:
git clone [email protected]:HdSeKenny/sweet-chatter.git
And then install dependencies with yarn.
$ cd sweet-chatter
$ yarn
Note: If you can't use yarn for some reason, try npm install
.
Start the app in the dev
environment. This starts the renderer process in hot-module-replacement mode and starts a server sends hot updates to the renderer process:
$ npm run dev
You Run these two commands simultaneously in different console tabs:
$ npm run hot-updates-server
$ npm run start-hot-renderer
Atom
apm install editorconfig es6-javascript atom-ternjs javascript-snippets linter linter-eslint language-babel autocomplete-modules file-icons
VSCode
- Editorconfig
- ESLint
- Flow
- Babel
- Jest
- ES6 Snippets
- React Snippets
๐ก If you are using the
flow-for-vscode
plugin, make sure to disable theflowtype-errors/show-errors
eslint rule in the.eslintrc
by setting it to0
Sublime
- Editorconfig Integration
- Linting
- ESLint Integration
- Syntax Highlighting
- Autocompletion
- Node Snippets
- ES6 Snippets
Others
- Editorconfig
- ESLint
- Babel Syntax Plugin
- OS X: Cmd Alt I or F12
- Linux: Ctrl Shift I or F12
- Windows: Ctrl Shift I or F12
See electron-debug for more information.
This boilerplate is included following DevTools extensions:
- Devtron - Install via electron-debug.
- React Developer Tools - Install via electron-devtools-installer.
- Redux DevTools - Install via electron-devtools-installer.
You can find the tabs on Chrome DevTools.
If you want to update extensions version, please set UPGRADE_EXTENSIONS
env, just run:
$ UPGRADE_EXTENSIONS=1 npm run dev
# For Windows
$ set UPGRADE_EXTENSIONS=1 && npm run dev
๐ก You can debug your production build with devtools by simply setting the DEBUG_PROD
env variable:
DEBUG_PROD=true npm run package
This boilerplate out of the box is configured to use css-modules.
All .css
file extensions will use css-modules unless it has .global.css
.
If you need global styles, stylesheets with .global.css
will not go through the
css-modules loader. e.g. app.global.css
If you want to import global css libraries (like bootstrap
), you can just write the following code in .global.css
:
@import "~bootstrap/dist/css/bootstrap.css";
If you want to use Sass in your app, you only need to import .sass
files instead of .css
once:
import './app.global.scss';
To package apps for the local platform:
$ npm run package
To package apps for all platforms:
First, refer to Multi Platform Build for dependencies.
Then,
$ npm run package-all
To package apps with options:
$ npm run package -- --[option]
MIT ยฉ Kenny