Breakout App

Helper app for Breakout platform.

Getting started

On this project, we're using pnpm. Please install it first.

cd breakout-app
nvm install
nvm use
pnpm install

How to run it

Copy the env.example into the .env and run the start:

pnpm start

Contributing

Before you commit on this project, we need run the checks on your code. It's automatically done using the Husky on the pre-commit hook. If it's not running or you're receiving this message, maybe you need to check the permissions and run a chmod:

hint: The '.husky/pre-commit' hook was ignored because it's not set as executable.
hint: You can disable this warning with `git config advice.ignoredHook false`.

Environment variables

The environment variables need to be access through the process.env.YOUR_VARIABLE (deconstruct will not work). You'll need to define all the variables on the .env.example to make them available on the Main and the Renderer.

Debugging

Click on View and Toggle Developer Tools on the Electron app. If this is not working, check if the variable devTools is true on /electron/main.ts

Possible errors

If you want to add a new package to the project and the webpack keep showing an error and asking for a fallback. Just add your package to resolve.fallback on webpack.renderer.config.js and set it to false.

resolve: {
  fallback: {
    crypto: false,
    'your_package': false
  }
}