The GitButler version control client, backed by Git, powered by Tauri/Rust/Svelte
Go to file
idonahue db31731e18 Refactor “sync with gitbutler modal" and add GitButler features
This commit refactors the sync with gitbutler modal layout and adds a list of GitButler features for new users. The diff shows the addition of a right box for displaying the GitButler description and feature list, and retains the left box for adding a new project. The feature list includes three primary features: recording actions, simplifying Git work, and code context search. The new layout provides a more informative and concise introduction to GitButler for users who have not started any projects.
2023-05-19 13:56:19 +02:00
.github run apt-get update in actions 2023-05-16 13:20:04 +02:00
.vscode recommend eslint and prettier plugin for vscode 2023-02-27 13:26:17 +01:00
scripts better sentry setup 2023-04-21 16:10:06 +02:00
src Refactor “sync with gitbutler modal" and add GitButler features 2023-05-19 13:56:19 +02:00
src-tauri save bookmarks into sessions 2023-05-19 10:57:50 +02:00
.env.development Posthog integration GB-36 (#18) 2023-02-22 14:38:45 +01:00
.env.production Posthog integration GB-36 (#18) 2023-02-22 14:38:45 +01:00
.eslintignore replace storybook with histoire 2023-05-09 09:57:59 +02:00
.eslintrc.cjs add linter for stores 2023-05-12 12:34:31 +02:00
.gitignore replace storybook with histoire 2023-05-09 09:57:59 +02:00
.npmrc simple tauri example 2023-01-31 15:55:57 +01:00
.prettierignore replace storybook with histoire 2023-05-09 09:57:59 +02:00
.prettierrc include prettier-plugin-tailwindcss into config 2023-03-07 11:53:11 +01:00
histoire.config.ts replace storybook with histoire 2023-05-09 09:57:59 +02:00
histoire.setup.ts replace storybook with histoire 2023-05-09 09:57:59 +02:00
package.json bump deps 2023-05-16 08:20:07 +02:00
pnpm-lock.yaml bump deps 2023-05-16 08:20:07 +02:00
postcss.config.cjs sort out lint/format setup 2023-02-24 10:46:41 +01:00
README.md replace storybook with histoire 2023-05-09 09:57:59 +02:00
svelte.config.js fallback to index.html 2023-04-25 12:40:04 +02:00
tailwind.config.cjs add link project modal 2023-05-10 14:29:13 +02:00
tsconfig.json fix remaining eslint issues 2023-02-24 11:00:17 +01:00
vite.config.ts do not create sentry release locally 2023-04-27 08:54:29 +02:00

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.