Skip to content

Commit 6f45dd1

Browse files
committed
feat: migrate from webpack to vite
Signed-off-by: Adam Setch <adam.setch@outlook.com>
1 parent e7a7716 commit 6f45dd1

24 files changed

Lines changed: 760 additions & 3646 deletions

CONTRIBUTING.md

Lines changed: 34 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,45 @@
11
# Gitify Contributing Guide
22

3-
Hi! We're really excited that you're interested in contributing to Gitify! Before submitting your contribution, please read through the following guide. We also suggest you read the [Project Philosophy](#project-philosophy) in our documentation.
3+
Hi! We're really excited that you're interested in contributing to Gitify!
44

5-
### Installation
5+
Before submitting your contribution, please read through the following guide.
66

7-
To get started, you'll need to clone the repository and install the dependencies.
8-
9-
```shell
10-
pnpm install
11-
```
12-
13-
### Development
7+
We also suggest you read the [Project Philosophy](#project-philosophy) in our documentation.
148

9+
### Getting Started
1510
> [!TIP]
1611
> _Optional: If you prefer to use your own OAuth credentials, you can do so by passing them as environment variables when bundling the app. This is optional as the app has some default "development" keys (use at your own discretion)._
1712
> ```shell
1813
> OAUTH_CLIENT_ID="123" pnpm build
1914
> ```
2015
21-
Copy the `.env.template` to `.env` and add update `GITHUB_TOKEN` with a GitHub Personal Access Token. This is used for fetching the latest GitHub GraphQL API schema for `graphql-codegen`.
22-
```shell
23-
GITHUB_TOKEN=<some personal access token>
24-
```
16+
To get started:
2517
26-
To watch for changes (`webpack`) in the `src` directory:
18+
Clone the repository and install dependencies:
19+
```shell
20+
pnpm install
21+
```
2722
23+
Copy the `.env.template` to `.env` and add update `GITHUB_TOKEN` with a GitHub Personal Access Token. This is used for fetching the latest GitHub GraphQL API schema for `graphql-codegen`.
2824
```shell
29-
pnpm watch
25+
GITHUB_TOKEN=<some personal access token>
3026
```
3127

32-
To run the **electron app**:
28+
Build static resources (tray icons, twemojis, etc). You only need to rebuild if you change static assets:
29+
```shell
30+
pnpm build
31+
```
3332

34-
```shell
35-
pnpm start
36-
```
37-
38-
To reload the app with the changes that `pnpm watch` has detected, you can use the `CmdOrCtrl+R` shortcut.
33+
Start development mode (includes GraphQL codegen and hot module reload):
34+
```shell
35+
pnpm dev
36+
```
3937

4038
### Tests
4139

42-
There are 2 checks:
43-
1. linter & formatter with [biome][biome-website]
44-
2. unit tests with [jvitestt][vitest-website]
40+
There are two main checks:
41+
1. Linter & formatter with [Biome][biome-website]
42+
2. Unit tests with [Vitest][vitest-website]
4543

4644
```shell
4745
# Run biome to check linting and formatting
@@ -54,6 +52,17 @@ pnpm test
5452
pnpm test -u
5553
```
5654

55+
### Code Style & Conventions
56+
57+
- We use [Biome][biome-website] for linting and formatting. Please run `pnpm lint:check` before submitting a PR.
58+
- Follow existing file and folder naming conventions.
59+
- Keep commit messages clear and descriptive.
60+
61+
### How to Report Bugs or Request Features
62+
63+
If you encounter a bug or have a feature request, please [open an issue][github-issues] with clear steps to reproduce or a detailed description of your idea. Check for existing issues before creating a new one.
64+
65+
5766
### Releases
5867

5968
The release process is automated. Follow the steps below.
@@ -95,6 +104,7 @@ This project is a tool for monitoring new notifications from GitHub. It's not me
95104
<!-- LINK LABELS -->
96105
[biome-website]: https://biomejs.dev/
97106
[github-dependency-dashboard]: https://github.com/gitify-app/gitify/issues/576
107+
[github-issues]: https://github.com/setchy/gitify/issues
98108
[github-milestones]: https://github.com/gitify-app/gitify/milestones
99109
[github-new-milestone]: https://github.com/gitify-app/gitify/milestones/new
100110
[github-new-release]: https://github.com/gitify-app/gitify/releases/new

config/webpack.config.common.ts

Lines changed: 0 additions & 24 deletions
This file was deleted.

config/webpack.config.main.base.ts

Lines changed: 0 additions & 24 deletions
This file was deleted.

config/webpack.config.main.prod.ts

Lines changed: 0 additions & 18 deletions
This file was deleted.

config/webpack.config.preload.base.ts

Lines changed: 0 additions & 24 deletions
This file was deleted.

config/webpack.config.preload.prod.ts

Lines changed: 0 additions & 18 deletions
This file was deleted.

config/webpack.config.renderer.base.ts

Lines changed: 0 additions & 109 deletions
This file was deleted.

config/webpack.config.renderer.prod.ts

Lines changed: 0 additions & 19 deletions
This file was deleted.

config/webpack.paths.ts

Lines changed: 0 additions & 28 deletions
This file was deleted.
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ const config = {
1111
'assets/sounds/*',
1212
'build/**/*',
1313
'LICENSE',
14-
'node_modules/**/*',
14+
'node_modules/**/*', // Ideally we would have !node_modules and let electron-builder prune deps
1515
'package.json',
1616
],
1717
electronLanguages: ['en'],
@@ -51,6 +51,7 @@ const config = {
5151
},
5252
nsis: {
5353
oneClick: false,
54+
uninstallDisplayName: 'Gitify',
5455
},
5556
linux: {
5657
target: ['AppImage', 'deb', 'rpm'],

0 commit comments

Comments
 (0)