README.md

$$$ADD_PROJECT_NAME_HERE

This is a minimal TypeScript React Electron application.

Development

To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
git clone $$$ADD_REPO_URL_HERE
# Navigate into the repository
cd $$$ADD_PROJECT_NAME_HERE
# Install dependencies
npm install
# Run the app
npm start

To run it as an ordinary website rather than electron app (might be useful on headless systems): instead of npm start, execute npm run start-no-electron.

Testing

Tests are run with the Jest testing framework.

npm test

Repository folder structure

src/ - Where all of the source code of the application resides. test/ - Folder for all of the tests. dist/ - Webpack generated bundle to be run by electron.

Resources

• https://electron.atom.io/docs - Electron's documentation
• https://www.typescriptlang.org/ - Typescript
• https://nodejs.org/en/ - Node.js
• https://jestjs.io/ - Jest testing framework
• https://reactjs.org/ - React
• https://testing-library.com/docs/react-testing-library/intro/ - React testing library