Skip to content

Commit a1ddc7a

Browse files
authored
Merge pull request #195 from oslabs-beta/master
OverVue 11.0 final PR updates. Refactored codebase, Updated dependencies, fixed functionalities, updated to Composition API for code generation, fixed lingering bugs
2 parents 4ecafca + f57cf82 commit a1ddc7a

File tree

102 files changed

+16066
-42584
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

102 files changed

+16066
-42584
lines changed

.gitignore

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,10 @@ yarn-error.log*
3030
*.suo
3131
*.ntvs*
3232
*.njsproj
33-
*.sln
33+
*.sln
34+
35+
# Jest coverage reports
36+
coverage/
37+
38+
# Electron build directories
39+
dist/electron/

.vscode/settings.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
{
2-
"editor.tabSize": 2
2+
"editor.tabSize": 2,
3+
"svg.preview.background": "editor"
34
}

README.md

Lines changed: 376 additions & 366 deletions
Large diffs are not rendered by default.

__mocks__/styleMock.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
module.exports = {}
2+

electron-builder miniguide.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
This is for future OverVue iteration groups to help in building out the application for github release
2+
3+
# Building Electron App with Electron-Builder
4+
5+
This guide provides instructions on how to use `electron-builder` to package and build your Electron app for different platforms.
6+
7+
## Prerequisites
8+
9+
- Node.js and npm installed on your system.
10+
- Project dependencies installed. Run `npm install` in the project root.
11+
12+
## Files notes
13+
14+
-the electron-builder.yml file holds the instructions for the electron-builder to config when building out the targets for mac,windows, and linux OSs
15+
-the 'main' path (in package.json) should be kept as "main": "./dist/electron/UnPackaged/electron-main.js", as this is the output main js after TypeScript compiles the code
16+
17+
## Building the App
18+
19+
**Build the Electron app**: Run the build script specified in your `package.json` file. The build script should look something like this: `"build": "quasar build -m electron"`. Run the build script with the command `npm run build`.
20+
21+
## Packaging the App for Different Platforms
22+
23+
After building the Electron app, then you can use `electron-builder` to package the app for different platforms:
24+
25+
- **Windows**: Run the command `npm run build:win` to package the app for Windows. This will create a `.exe` file in the `dist` directory.
26+
27+
- **macOS**: Run the command `npm run build:mac` to package the app for macOS. This will create a `.dmg` file in the `dist` directory.
28+
29+
- **Linux**: Run the command `npm run build:linux` to package the app for Linux. This will create an `AppImage` file in the `dist` directory.
30+
31+
## Releasing the App
32+
33+
After packaging the app, you can upload the packaged files to the releases section of your GitHub repository. Users can then download these files to install your Electron app on their respective platforms.

electron-builder.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
appId: com.electron.OverVue
2+
productName: OverVue 11.0
3+
directories:
4+
app: "./dist/electron/UnPackaged"
5+
mac:
6+
target: zip
7+
icon: "src-electron/icons/tileIconMac.icns"
8+
win:
9+
target: portable
10+
icon: "src-electron/icons/tileIconWin.ico"
11+
linux:
12+
target: AppImage
13+
icon: "src-electron/icons/tileIconLinux.png"

jest.config.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,8 @@ module.exports = {
5353
'^pages/(.*)$': '<rootDir>/src/pages/$1',
5454
'^assets/(.*)$': '<rootDir>/src/assets/$1',
5555
'^boot/(.*)$': '<rootDir>/src/boot/$1',
56-
'.*css$': '@quasar/quasar-app-extension-testing-unit-jest/stub.css',
56+
'\\.(css)$': '<rootDir>/__mocks__/styleMock.js',
57+
'^@/(.*)$': '<rootDir>/src/$1',
5758
},
5859
preset: 'ts-jest',
5960
transform: {

0 commit comments

Comments
 (0)