Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 2.73 KB

README.md

File metadata and controls

38 lines (29 loc) · 2.73 KB
Raw

React/Electron + TailwindCSS starter project

This project is currently in pre-release state.

This is a simple starter project for developers looking to make Electron Apps with a React Frontend + TailwindCSS for styling.

Why use this template over others?

You should use this template over others if you are targeting Linux as a platform, as others make use of electron-forge or the default electron-updater. This project uses electron-builder which allows for automatic updating via Snap on Linux. It's also much more simple and scaled back than other templates. Everything is simpler and easier to understand - other templates are perhaps too configured, and make use of far to many dependancies.

What this project does include

  • This project is based (loosely) on the official create-react-app repository - as such it mirrors that mostly in terms of commands, file structure and more.
  • tailwindcss
  • Built for Yarn
  • Electron-builder built in
  • A simple and easy-to-read package.json

Development

This project was bootstrapped with create-react-app roughly following this guide, as well as the offical TailwindCSS guide for create-react-app and a fully public template of the base of this project is available here

This project uses Yarn (v1) - for a number of reasons. NPM, NPX should work, but are not supported. You will need to install yarn globally with npm with npm install -g yarn

You can clone this repository with git clone https://github.com/theshoregroup/digital-signage

Once on your local machine, you will need to run yarn in the project's root directory to grab all the applicable node_modules.

Scripts

start:react - starts the react development server on port 3000
start - starts the full project in development mode
build:react - builds the react part of the project to /build/
build:electron - builds the electron part of the project
build - builds the full project
release - builds and packages the full project (by default on the platform you run the command on)
test:react - runs the intergrated react-scripts tests
eject:react - ADVANCED Runs the react-scripts eject command. This is irreversible - MAKE SURE YOU KNOW WHAT YOU ARE DOING!

Essentially:

  • If you are running this in development mode, either to test or develop on, run yarn start
  • If you are packaging this - please read the section on packaging below - however for testing a packaged version, run yarn release