| .github | ||
| .vscode | ||
| butler | ||
| scripts | ||
| src | ||
| src-tauri | ||
| .env.development | ||
| .env.nightly | ||
| .env.production | ||
| .eslintignore | ||
| .eslintrc.cjs | ||
| .gitignore | ||
| .npmrc | ||
| .prettierignore | ||
| .prettierrc | ||
| histoire.config.ts | ||
| histoire.setup.ts | ||
| package.json | ||
| pnpm-lock.yaml | ||
| postcss.config.cjs | ||
| README.md | ||
| svelte.config.js | ||
| tailwind.config.cjs | ||
| tsconfig.json | ||
| vite.config.ts | ||
Development
Prerequisites
see here for the list of software required to build / develope the app.
Setup
Then, make sure to install app dependencies:
$ pnpm install
Run
Now you should be able to run the app in development mode:
$ pnpm tauri dev
Running Stories
Stories is our easy way to view our app components. Running the following command will launch in your default browser.
$ pnpm story:dev
Linting
Pull requests will not pass unless files are linted for proper Tailwind formatting.
$ pnpm format
building
To build the app in production mode, run:
$ pnpm tauri build
Icon generation
$ pnpm tauri icon path/to/icon.png
Releasing
Building is done via GitHub Action.
Go to the link and select Run workflow from the desired branch.
Versioning
When running the release action, you will have to choose one of major, minor, or patch release type. Action will generate a new version based on your input and current version found at https://app.gitbutler.com/releases.
publishing
To publish a version that you've just build, use Release Manager.
runners
Note that to build an arm64 macos app, you need to make sure that there is at least one self-hosted runner
with macos-aarch64 label is online here.
If you are a lucky owner of an arm64 macos machine, feel free to run it yourself.
Make sure to label it with macos-aarch64.