Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jinyaoma/my-app
A continuously updated personal service collection; Tech. Stack: Go, TypeScript, Wails v2, Systray, Gin, GORM, Vue 3, etc.
https://github.com/jinyaoma/my-app
gin go gorm systray typescript vue3 wails2
Last synced: about 1 month ago
JSON representation
A continuously updated personal service collection; Tech. Stack: Go, TypeScript, Wails v2, Systray, Gin, GORM, Vue 3, etc.
- Host: GitHub
- URL: https://github.com/jinyaoma/my-app
- Owner: jinyaoMa
- License: mit
- Created: 2022-09-11T20:29:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-16T03:56:52.000Z (about 1 year ago)
- Last Synced: 2024-11-15T22:29:59.789Z (about 1 month ago)
- Topics: gin, go, gorm, systray, typescript, vue3, wails2
- Language: Go
- Homepage:
- Size: 3.63 MB
- Stars: 98
- Watchers: 4
- Forks: 22
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# My Application (my-app)
> [English](./README.md) | [简体中文](./README.zh.md)
My Application is a continuously updated personal service collection.
## Starter Code Preview
> You can find all preview screenshots [here](./screenshots/).
## Technologies
| Technology | Role | Sources |
| :---------- | :---------------------------------------------------- | :-------------------------------------- |
| Go | Backend programming language | https://pkg.go.dev/std |
| TypeScript | Frontend programming language | https://typescriptlang.org/ |
| Sass/Scss | Frontend CSS extension language | https://sass-lang.com/dart-sass |
| Vite | Next Generation Frontend Tooling | https://vitejs.dev/ |
| Vue 3 | Progressive JavaScript Framework | https://vuejs.org/ |
| Wails v2 | Build cross-platform desktop applications using Go | https://wails.io/ |
| UPX | Ultimate packer for executables | https://upx.github.io/ |
| Systray | A cross platfrom system tray using Go | https://github.com/getlantern/systray |
| Gin | A HTTP web framework using Go | https://gin-gonic.com/ |
| Gin Swagger | Gin middleware for API documentation with Swagger 2.0 | https://github.com/swaggo/gin-swagger |
| Swaggo | Converts Go annotations to Swagger Documentation 2.0 | https://github.com/swaggo/swag |
| Air | Live reload and test for API service | https://github.com/cosmtrek/air |
| GORM | ORM library for Go | https://gorm.io/ |
| SQLite | GORM sqlite driver | https://github.com/go-gorm/sqlite |
| SVG To Font | Generator of fonts from SVG icons | https://github.com/jaywcjlove/svgtofont |
## Setup
Prepare and install environment for development in Window 10/11?
- Git v2.37+, https://git-scm.com/
- Go v1.19+, https://go.dev/
- Node.js v16+, https://nodejs.org/
- PNPM v7+, https://pnpm.io/
- VS Code v1.71+ with GCC, https://code.visualstudio.com/docs/cpp/config-mingw
- WebView2 v104+, https://developer.microsoft.com/en-us/microsoft-edge/webview2/
> Setup VS Code by installing recommended extensions. To do this, enter in `@recommended` while searching for extensions.
> Run command `go env -w CGO_ENABLED=1` to prepare for _CGO_ enabled packages
> Run command `pnpm install` at project root directory to setup.
> Want to update dependencies? Run command `pnpm update:dependencies` at project root directory to setup. Also may need to manually edit `peerDependencies` in all `package.json` files inside `frontend/packages` folder and its sub folders.
## NPM Scripts
```shell
$ pnpm wails:dev # run wails in development mode
$ pnpm wails:build # build wails application
$ pnpm upx:compress # compress the generated executable by `wails:build` script
$ pnpm air:dev # test API service individually
$ pnpm swag:docs # generate/update swagger docs
$ pnpm docs:dev # test vitepress docs individually
$ pnpm docs:build # generate/update vitepress docs
$ pnpm icons:build # build frontend/packages/icons
$ pnpm design:build # build frontend/packages/design
$ pnpm <[install|preinstall]:[task]> # install/preinstall scripts trigger during project setup
```
## Directory Structure
```yaml
.
├── .tools # auto-generated, development tools/CLIs
├── .vscode # extensions for VS Code
├── air # sources related to air hot reload tool
│ ├── bin # auto-generated, try script `air:dev`
│ ├── .air.toml # air config
│ └── main.go # run web service individually w/o wails and tray
├── backend # sources related to backend code
│ ├── app # app module, business layer
│ │ ├── config # load application options from database, global resource
│ │ │ ├── config.go # application config with functions for state and database manupulation
│ │ │ ├── config.web.go # web config
│ │ │ └── env.go # load os environment variable
│ │ ├── i18n # manage locale/translation strings for backend, global resource
│ │ ├── logger # setup loggers
│ │ └── app.go # setup global state and resources
│ ├── model # model module, persistence layer
│ │ ├── model.go # setup database, table prefix `my_`
│ │ └── my_option.go # define application options for app config storage
│ ├── pkg # pkg module, cross cutting
│ │ └── utils # helper functions
│ ├── service # service module, business layer
│ │ ├── service.go # initialize provided services
│ │ └── settings.go # functions about configure application
│ ├── tray # tray module, presentation layer
│ │ ├── icons # tray icons
│ │ ├── menus # tray menu types
│ │ ├── expose.go # functions exposed to wails frontend
│ │ ├── listen.go # listen to tray menu-item click events
│ │ ├── ready.go # onReady() for system tray to initialize tray menu
│ │ ├── refresh.go # refresh functions for language switch and tray icon tooltip
│ │ └── tray.go # setup system tray
│ └── web # web module, service layer
│ ├── api # API services
│ ├── auth # Auth services
│ ├── middleware # custom gin middlewares
│ ├── static # static websites and sources
│ │ ├── certs # auto-generated for localhost TLS, try script `install:certs`
│ │ ├── swagger # auto-generated, try script `swag:docs`
│ │ ├── static.go # manage static sources
│ │ └── # ...
│ ├── air.go # special function for air to test API service individually
│ ├── router.go # entry point of swaggo docs generator, manage routes for API
│ └── web.go # web service
├── build # sources to use during wails build process
│ ├── bin # auto-generated, try script `wails:dev` or `wails:build`
│ │ ├── Assets # wails frontend static resources, auto-generated, try script `wails:build`
│ │ ├── Docs # vitepress docs static resources, auto-generated, try script `docs:build`
│ │ ├── UserData # webview2 user data, auto-generated during application runtime
│ │ └── # ...
│ └── # ...
├── diagrams # diagrams about 4+1 view model
├── docs # vitepress documentation
├── frontend # sources related to frontend code, workplace managed by PNPM
│ ├── packages # frontend components, icons, etc.
│ ├── src # wails frontend sources
│ │ ├── vite-env.d.ts # put go struct associated types into it
│ │ └── # ...
│ └── # ...
├── screenshots # README application preview screenshots
├── main.go # wails main application, presentation layer
├── main.wails.go # wails life cycle
├── wails.json # wails CLI config
└── # ...
```
## Development View
