Docs: Add community page(s) (#3941)

* docs: fix tip

* update packages

* add showase

* add 3 showcases from v2

* mdx -> md

* add links page

* add templates page with a caution

* add a tip

* move desc up

* use X instead of twitter

* fix link

* Add clave

* add how to section
This commit is contained in:
Stavros Kois 2024-12-09 22:53:36 +02:00 committed by GitHub
commit 6be3295205
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
72 changed files with 1188 additions and 761 deletions

1
docs/.npmrc Normal file
View file

@ -0,0 +1 @@
save-exact=true

View file

@ -20,6 +20,8 @@ export default defineConfig({
sitemap(),
starlight({
title: "",
// If a title is added, also update the delimiter.
titleDelimiter: "",
logo: {
dark: "./src/assets/wails-logo-horizontal-dark.svg",
light: "./src/assets/wails-logo-horizontal-light.svg",
@ -100,6 +102,21 @@ export default defineConfig({
collapsed: true,
autogenerate: { directory: "api", collapsed: true },
},
{
label: "Community",
collapsed: true,
items: [
{ label: "Links", link: "/community/links" },
{ label: "Templates", link: "/community/templates" },
{
label: "Showcase",
autogenerate: {
directory: "community/showcase",
collapsed: true,
},
},
],
},
{
label: "Development",
collapsed: true,

1150
docs/package-lock.json generated

File diff suppressed because it is too large Load diff

View file

@ -10,13 +10,14 @@
"astro": "astro"
},
"dependencies": {
"@astrojs/check": "^0.9.4",
"@astrojs/starlight": "^0.29.2",
"astro": "^4.16.10",
"sharp": "^0.32.5",
"@astrojs/check": "0.9.4",
"@astrojs/starlight": "0.29.2",
"astro": "4.16.17",
"sharp": "0.33.5",
"starlight-blog": "0.15.0",
"starlight-image-zoom": "0.9.0",
"starlight-links-validator": "0.13.2",
"typescript": "^5.7.2"
"starlight-links-validator": "0.13.4",
"starlight-showcases": "0.2.0",
"typescript": "5.7.2"
}
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 135 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 146 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 89 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 440 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 188 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 156 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 140 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 119 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

View file

@ -0,0 +1,32 @@
---
title: Links
---
This page serves as a list for community related links.
:::tip[How to Submit a Link]
You can click the `Edit this page` at the bottom of this page to submit a PR.
:::
## Awesome Wails
The [definitive list](https://github.com/wailsapp/awesome-wails) of links
related to Wails.
## Support Channels
- [Wails Discord Server](https://discord.gg/JDdSxwjhGf)
- [Github Issues](https://github.com/wailsapp/wails/issues)
- [v2 Beta Discussion Board](https://github.com/wailsapp/wails/discussions/828)
## Social Media
- [Twitter](https://x.com/wailsapp)
- [Wails Chinese Community QQ Group](https://qm.qq.com/cgi-bin/qm/qr?k=PmIURne5hFGNd7QWzW5qd6FV-INEjNJv&jump_from=webapi) -
Group number: 1067173054
## Other Tutorials and Articles
- [Building of Bulletin Board](https://blog.customct.com/building-bulletin-board)

View file

@ -0,0 +1,13 @@
---
title: My Project
---
<!-- This is an image -->
![My Project](../../../../assets/showcase-images/my-project.webp)
<!-- Add some content here -->
<!-- This is a link -->
[My Project](https://my-project.com)

View file

@ -0,0 +1,16 @@
---
title: BulletinBoard
---
![BulletinBoard](../../../../assets/showcase-images/bboard.webp)
The [BulletinBoard](https://github.com/raguay/BulletinBoard) application is a
versital message board for static messages or dialogs to get information from
the user for a script. It has a TUI for creating new dialogs that can latter be
used to get information from the user. It's design is to stay running on your
system and show the information as needed and then hide away. I have a process
for watching a file on my system and sending the contents to BulletinBoard when
changed. It works great with my workflows. T here is also an
[Alfred workflow](https://github.com/raguay/MyAlfred/blob/master/Alfred%205/EmailIt.alfredworkflow)
for sending information to the program. The workflow is also for working with
[EmailIt](https://github.com/raguay/EmailIt).

View file

@ -0,0 +1,36 @@
---
title: CFN Tracker
---
![CFN Tracker](../../../../assets/showcase-images/cfntracker.webp)
[CFN Tracker](https://github.com/williamsjokvist/cfn-tracker) - Track any Street
Fighter 6 or V CFN profile's live matches. Check
[the website](https://cfn.williamsjokvist.se/) to get started.
## Features
- Real-time match tracking
- Storing match logs and statistics
- Support for displaying live stats to OBS via Browser Source
- Support for both SF6 and SFV
- Ability for users to create their own OBS Browser themes with CSS
### Major tech used alongside Wails
- [Task](https://github.com/go-task/task) - wrapping the Wails CLI to make
common commands easy to use
- [React](https://github.com/facebook/react) - chosen for its rich ecosystem
(radix, framer-motion)
- [Bun](https://github.com/oven-sh/bun) - used for its fast dependency
resolution and build-time
- [Rod](https://github.com/go-rod/rod) - headless browser automation for
authentication and polling changes
- [SQLite](https://github.com/mattn/go-sqlite3) - used for storing matches,
sessions and profiles
- [Server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events) -
a http stream to send tracking updates to OBS browser sources
- [i18next](https://github.com/i18next/) - with backend connector to serve
localization objects from the Go layer
- [xstate](https://github.com/statelyai/xstate) - state machines for auth
process and tracking

View file

@ -0,0 +1,18 @@
---
title: Clave
---
![Clave](../../../../assets/showcase-images/clave.gif)
Key Features
- 🎨 Simple, intuitive design for hassle-free experience
- ✅ Add accounts easily via manual entry or QR code image import.
- 🔒 End-to-end encryption with PIN or Touch ID(macOS only).
- 💻 Available for macOS, Windows, and Linux
- ⚡ Quick access from system tray for convenience
- 📂 Easily backup and restore your profiles
Try Clave Today!
💻 [https://clave.rocks](https://clave.rocks)

View file

@ -0,0 +1,14 @@
---
title: EmailIt
---
![EmailIt](../../../../assets/showcase-images/emailit.webp)
[EmailIt](https://github.com/raguay/EmailIt/) is a Wails 2 program that is a
markdown based email sender only with nine notepads, scripts to manipulate the
text, and templates. It also has a scripts terminal to run scripts in EmailIt on
files in your system. The scripts and templates can be used from the commandline
itself or with the Alfred, Keyboard Maestro, Dropzone, or PopClip extensions. It
also supports scripts and themes downloaded form GitHub. Documentation is not
complete, but the programs works. Its built using Wails2 and Svelte, and the
download is a universal macOS application.

View file

@ -0,0 +1,16 @@
---
title: EncryptEasy
---
![EncryptEasy](../../../../assets/showcase-images/encrypteasy.webp)
**[EncryptEasy](https://www.encrypteasy.app) is a simple and easy to use PGP
encryption tool, managing all your and your contacts keys. Encryption should be
simple. Developed with Wails.**
Encrypting messages using PGP is the industry standard. Everyone has a private
and a public key. Your private key, well, needs to be kept private so only you
can read messages. Your public key is distributed to anyone who wants to send
you secret, encrypted messages. Managing keys, encrypting messages and
decrypting messages should be a smooth experience. EncryptEasy is all about
making it easy.

View file

@ -0,0 +1,9 @@
---
title: ESP Studio
---
![ESP Studio](../../../../assets/showcase-images/esp-studio.png)
[ESP Studio](https://github.com/torabian/esp-studio) - Cross platform, Desktop,
Cloud, and Embedded software for controlling ESP/Arduino devices, and building
complex IOT workflows and control systems

View file

@ -0,0 +1,29 @@
---
title: FileHound Export Utility
---
![FileHound Export Utility](../../../../assets/showcase-images/filehound.webp)
[FileHound Export Utility](https://www.filehound.co.uk/) FileHound is a cloud
document management platform made for secure file retention, business process
automation and SmartCapture capabilities.
The FileHound Export Utility allows FileHound Administrators the ability to run
a secure document and data extraction tasks for alternative back-up and recovery
purposes. This application will download all documents and/or meta data saved in
FileHound based on the filters you choose. The metadata will be exported in both
JSON and XML formats.
Backend built with:
- Go 1.15
- Wails 1.11.0
- go-sqlite3 1.14.6
- go-linq 3.2
Frontend with:
- Vue 2.6.11
- Vuex 3.4.0
- TypeScript
- Tailwind 1.9.6

View file

@ -0,0 +1,8 @@
---
title: hiposter
---
![hiposter](../../../../assets/showcase-images/hiposter.webp)
[hiposter](https://github.com/obity/hiposter) is a simple and efficient http API
testing client tool. Based on Wails, Go and sveltejs.

View file

@ -0,0 +1,189 @@
---
title: Overview
sidebar:
order: 1
---
import { ShowcaseImage } from "starlight-showcases";
import { Steps } from "@astrojs/starlight/components";
:::tip[See how to add your project]
Check out the
[How to add my project in showcase](#how-to-add-my-project-in-showcase) section.
:::
<ShowcaseImage
entries={[
{
thumbnail: import("../../../../assets/showcase-images/bboard.webp"),
href: "/community/showcase/bulletinboard",
title: "BulletinBoard",
},
{
thumbnail: import("../../../../assets/showcase-images/cfntracker.webp"),
href: "/community/showcase/cfntracker",
title: "CFN Tracker",
},
{
thumbnail: import("../../../../assets/showcase-images/clave.gif"),
href: "/community/showcase/clave",
title: "Clave",
},
{
thumbnail: import("../../../../assets/showcase-images/emailit.webp"),
href: "/community/showcase/emailit",
title: "EmailIt",
},
{
thumbnail: import("../../../../assets/showcase-images/encrypteasy.webp"),
href: "/community/showcase/encrypteasy",
title: "EncryptEasy",
},
{
thumbnail: import("../../../../assets/showcase-images/esp-studio.png"),
href: "/community/showcase/espstudio",
title: "ESP Studio",
},
{
thumbnail: import("../../../../assets/showcase-images/filehound.webp"),
href: "/community/showcase/filehound",
title: "FileHound Export Utility",
},
{
thumbnail: import("../../../../assets/showcase-images/hiposter.webp"),
href: "/community/showcase/hiposter",
title: "hiposter",
},
{
thumbnail: import("../../../../assets/showcase-images/mchat.gif"),
href: "/community/showcase/mchat",
title: "Mchat",
},
{
thumbnail: import(
"../../../../assets/showcase-images/minecraft-mod-updater.webp"
),
href: "/community/showcase/minecraftupdater",
title: "Minecraft Updater",
},
{
thumbnail: import(
"../../../../assets/showcase-images/minesweeper-xp.webp"
),
href: "/community/showcase/minesweeper-xp",
title: "Minesweeper XP",
},
{
thumbnail: import(
"../../../../assets/showcase-images/modalfilemanager.webp"
),
href: "/community/showcase/modalfilemanager",
title: "Modal File Manager",
},
{
thumbnail: import("../../../../assets/showcase-images/mollywallet.webp"),
href: "/community/showcase/mollywallet",
title: "Molly Wallet",
},
{
thumbnail: import("../../../../assets/showcase-images/october.webp"),
href: "/community/showcase/october",
title: "October",
},
{
thumbnail: import("../../../../assets/showcase-images/optimus.webp"),
href: "/community/showcase/optimus",
title: "Optimus",
},
{
thumbnail: import("../../../../assets/showcase-images/portfall.webp"),
href: "/community/showcase/portfall",
title: "Portfall",
},
{
thumbnail: import("../../../../assets/showcase-images/resizem.webp"),
href: "/community/showcase/resizem",
title: "Resizem",
},
{
thumbnail: import(
"../../../../assets/showcase-images/restic-browser-2.png"
),
href: "/community/showcase/restic-browser",
title: "Restic Browser",
},
{
thumbnail: import(
"../../../../assets/showcase-images/riftshare-main.webp"
),
href: "/community/showcase/riftshare",
title: "RiftShare",
},
{
thumbnail: import("../../../../assets/showcase-images/scriptbar.webp"),
href: "/community/showcase/scriptbar",
title: "ScriptBar",
},
{
thumbnail: import(
"../../../../assets/showcase-images/snippetexpandergui-search-and-paste.png"
),
href: "/community/showcase/snippetexpander",
title: "Snippet Expander",
},
{
thumbnail: import("../../../../assets/showcase-images/surge.png"),
href: "/community/showcase/surge",
title: "Surge",
},
{
thumbnail: import("../../../../assets/showcase-images/tiny-rdm1.webp"),
href: "/community/showcase/tinyrdm",
title: "Tiny RDM",
},
{
thumbnail: import("../../../../assets/showcase-images/wailsterm.webp"),
href: "/community/showcase/wailsterm",
title: "WailsTerm",
},
{
thumbnail: import("../../../../assets/showcase-images/wally.webp"),
href: "/community/showcase/wally",
title: "Wally",
},
{
thumbnail: import("../../../../assets/showcase-images/warmine1.png"),
href: "/community/showcase/warmine",
title: "WarMine",
},
{
thumbnail: import("../../../../assets/showcase-images/wombat.webp"),
href: "/community/showcase/wombat",
title: "Wombat",
},
{
thumbnail: import("../../../../assets/showcase-images/ytd.webp"),
href: "/community/showcase/ytd",
title: "Ytd",
},
]}
/>
## How to add my project in showcase
<Steps>
1. Make a fork of the repository.
2. Add the image(s) under `docs/src/assets/showcase-images` folder.
3. Make a copy of the `_template.md` file under
`docs/src/content/docs/community/showcase` folder.
4. Rename the copied file to the name of your project. (Name should not start
with `_`))
5. Update the title, image, link and content of the file.
6. Add it on the above list in
`docs/src/content/docs/community/showcase/index.mdx`.
7. Submit a PR.
</Steps>

View file

@ -0,0 +1,8 @@
---
title: Mchat
---
![Mchat](../../../../assets/showcase-images/mchat.gif)
[Official page](https://marcio199226.github.io/mchat-site/public/) Fully
anonymous end2end encrypted chat.

View file

@ -0,0 +1,10 @@
---
title: Minecraft Updater
---
![Minecraft Updater](../../../../assets/showcase-images/minecraft-mod-updater.webp)
[Minecraft Updater](https://github.com/Gurkengewuerz/MinecraftModUpdater) is a
utility tool to update and synchronize Minecraft mods for your userbase. Its
built using Wails2 and React with [antd](https://ant.design/) as frontend
framework.

View file

@ -0,0 +1,8 @@
---
title: Minesweeper XP
---
![Minesweeper XP](../../../../assets/showcase-images/minesweeper-xp.webp)
[Minesweeper-XP](https://git.new/Minesweeper-XP) allows you to experience the
classic Minesweeper XP (+ 98 and 3.1) on macOS, Windows, and Linux!

View file

@ -0,0 +1,21 @@
---
title: Modal File Manager
---
![Modal File Manager](../../../../assets/showcase-images/modalfilemanager.webp)
[Modal File Manager](https://github.com/raguay/ModalFileManager) is a dual pane
file manager using web technologies. My original design was based on NW.js and
can be found [here](https://github.com/raguay/ModalFileManager-NWjs). This
version uses the same Svelte based frontend code (but it has be greatly modified
since the departure from NW.js), but the backend is a
[Wails 2](https://wails.io/) implementation. By using this implementation, I no
longer use command line `rm`, `cp`, etc. commands, but a git install has to be
on the system to download themes and extensions. It is fully coded using Go and
runs much faster than the previous versions.
This file manager is designed around the same principle as Vim: a state
controlled keyboard actions. The number of states isn't fixed, but very
programmable. Therefore, an infinite number of keyboard configurations can be
created and used. This is the main difference from other file managers. There
are themes and extensions available to download from GitHub.

View file

@ -0,0 +1,9 @@
---
title: Molley Wallet
---
![Molly Wallet](../../../../assets/showcase-images/mollywallet.webp)
[Molly Wallet](https://github.com/grvlle/constellation_wallet/) the official
$DAG wallet of the Constellation Network. It'll let users interact with the
Hypergraph Network in various ways, not limited to producing $DAG transactions.

View file

@ -0,0 +1,16 @@
---
title: October
---
![October](../../../../assets/showcase-images/october.webp)
[October](https://october.utf9k.net) is a small Wails application that makes it
really easy to extract highlights from
[Kobo eReaders](https://en.wikipedia.org/wiki/Kobo_eReader) and then forward
them to [Readwise](https://readwise.io).
It has a relatively small scope with all platform versions weighing in under
10MB, and that's without enabling [UPX compression](https://upx.github.io/)!
In contrast, the author's previous attempts with Electron quickly bloated to
several hundred megabytes.

View file

@ -0,0 +1,9 @@
---
title: Optimus
---
![Optimus](../../../../assets/showcase-images/optimus.webp)
[Optimus](https://github.com/splode/optimus) is a desktop image optimization
application. It supports conversion and compression between WebP, JPEG, and PNG
image formats.

View file

@ -0,0 +1,8 @@
---
title: Portfall
---
![Portfall](../../../../assets/showcase-images/portfall.webp)
[Portfall](https://github.com/rekon-oss/portfall) - A desktop k8s
port-forwarding portal for easy access to all your cluster UIs

View file

@ -0,0 +1,9 @@
---
title: Resizem
---
![Resizem Screenshot](../../../../assets/showcase-images/resizem.webp)
[Resizem](https://github.com/barats/resizem) - is an app designed for bulk image
process. It is particularly useful for users who need to resize, convert, and
manage large numbers of image files at once.

View file

@ -0,0 +1,9 @@
---
title: Restic Browser
---
![Restic Browser](../../../../assets/showcase-images/restic-browser-2.png)
[Restic-Browser](https://github.com/emuell/restic-browser) - A simple,
cross-platform [restic](https://github.com/restic/restic) backup GUI for
browsing and restoring restic repositories.

View file

@ -0,0 +1,23 @@
---
title: RiftShare
---
![RiftShare](../../../../assets/showcase-images/riftshare-main.webp)
Easy, Secure, and Free file sharing for everyone. Learn more at
[Riftshare.app](https://riftshare.app)
## Features
- Easy secure file sharing between computers both in the local network and
through the internet
- Supports sending files or directories securely through the
[magic wormhole protocol](https://magic-wormhole.readthedocs.io/en/latest/)
- Compatible with all other apps using magic wormhole (magic-wormhole or
wormhole-william CLI, wormhole-gui, etc.)
- Automatic zipping of multiple selected files to send at once
- Full animations, progress bar, and cancellation support for sending and
receiving
- Native OS File Selection
- Open files in one click once received
- Auto Update - don't worry about having the latest release!

View file

@ -0,0 +1,14 @@
---
title: ScriptBar
---
![ScriptBar](../../../../assets/showcase-images/scriptbar.webp)
[ScriptBar](https://GitHub.com/raguay/ScriptBarApp) is a program to show the
output of scripts or [Node-Red](https://nodered.org) server. It runs scripts
defined in EmailIt program and shows the output. Scripts from xBar or TextBar
can be used, but currently on the TextBar scripts work well. It also displays
the output of scripts on your system. ScriptBar doesn't put them in the menubar,
but has them all in a convient window for easy viewing. You can have multiple
tabs to have many different things show. You can also keep the links to your
most visited web sites.

View file

@ -0,0 +1,34 @@
---
title: Snippet Expander
---
![Snippet Expander Screenshot](../../../../assets/showcase-images/snippetexpandergui-select-snippet.png)
Screenshot of Snippet Expander's Select Snippet window
![Snippet Expander Screenshot](../../../../assets/showcase-images/snippetexpandergui-add-snippet.png)
Screenshot of Snippet Expander's Add Snippet screen
![Snippet Expander Screenshot](../../../../assets/showcase-images/snippetexpandergui-search-and-paste.png)
Screenshot of Snippet Expander's Search & Paste window
[Snippet Expander](https://snippetexpander.org) is "Your little expandable text
snippets helper", for Linux.
Snippet Expander comprises of a GUI application built with Wails for managing
snippets and settings, with a Search & Paste window mode for quickly selecting
and pasting a snippet.
The Wails based GUI, go-lang CLI and vala-lang auto expander daemon all
communicate with a go-lang daemon via D-Bus. The daemon does the majority of the
work, managing the database of snippets and common settings, and providing
services for expanding and pasting snippets etc.
Check out the
[source code](https://git.sr.ht/~ianmjones/snippetexpander/tree/trunk/item/cmd/snippetexpandergui/app.go#L38)
to see how the Wails app sends messages from the UI to the backend that are then
sent to the daemon, and subscribes to a D-Bus event to monitor changes to
snippets via another instance of the app or CLI and show them instantly in the
UI via a Wails event.

View file

@ -0,0 +1,9 @@
---
title: Surge
---
![Surge Screenshot](../../../../assets/showcase-images/surge.png)
[Surge](https://getsurge.io/) is a p2p filesharing app designed to utilize
blockchain technologies to enable 100% anonymous file transfers. Surge is
end-to-end encrypted, decentralized and open source.

View file

@ -0,0 +1,12 @@
---
title: Tiny RDM
---
![Tiny RDM Screenshot](../../../../assets/showcase-images/tiny-rdm1.webp)
![Tiny RDM Screenshot](../../../../assets/showcase-images/tiny-rdm2.webp)
The [Tiny RDM](https://redis.tinycraft.cc/) application is an open-source,
modern lightweight Redis GUI. It has a beautful UI, intuitive Redis database
management, and compatible with Windows, Mac, and Linux. It provides visual
key-value data operations, supports various data decoding and viewing options,
built-in console for executing commands, slow log queries and more.

View file

@ -0,0 +1,8 @@
---
title: WailsTerm
---
![WailsTerm Screenshot](../../../../assets/showcase-images/wailsterm.webp)
[WailsTerm](https://github.com/rlshukhov/wailsterm) is a simple translucent
terminal app powered by Wails and Xterm.js.

View file

@ -0,0 +1,10 @@
---
title: Wally
---
![Wally Screenshot](../../../../assets/showcase-images/wally.webp)
[Wally](https://ergodox-ez.com/pages/wally) is the official firmware flasher for
[Ergodox](https://ergodox-ez.com/) keyboards. It looks great and is a fantastic
example of what you can achieve with Wails: the ability to combine the power of
Go and the rich graphical tools of the web development world.

View file

@ -0,0 +1,17 @@
---
title: Minecraft launcher for WarMine
---
![WarMine Screenshot](../../../../assets/showcase-images/warmine1.png)
![WarMine Screenshot](../../../../assets/showcase-images/warmine2.png)
[Minecraft launcher for WarMine](https://warmine.ru/) is a Wails application,
that allows you to easily join modded game servers and manage your game
accounts.
The Launcher downloads the game files, checks their integrity and launches the
game with a wide range of customization options for the launch arguments from
the backend.
Frontend is written in Svelte, whole launcher fits in 9MB and supports Windows
7-11.

View file

@ -0,0 +1,7 @@
---
title: Wombat
---
![Wombat Screenshot](../../../../assets/showcase-images/wombat.webp)
[Wombat](https://github.com/rogchap/wombat) is a cross platform gRPC client.

View file

@ -0,0 +1,10 @@
---
title: Ytd
---
![Ytd Screenshot](../../../../assets/showcase-images/ytd.webp)
[Ytd](https://github.com/marcio199226/ytd/tree/v2-wails) is an app for
downloading tracks from youtube, creating offline playlists and share them with
your friends, your friends will be able to playback your playlists or download
them for offline listening, has an built-in player.

View file

@ -0,0 +1,132 @@
---
title: Templates
---
:::caution
This page might be outdated for Wails v3.
:::
<!-- TODO: Update this link -->
This page serves as a list for community supported templates. To build your own
template, please see the [Templates](https://wails.io/docs/guides/templates)
guide.
:::tip[How to Submit a Template]
You can click `Edit this page` at the bottom to include your templates.
:::
To use these templates, run
`wails init -n "Your Project Name" -t [the link below[@version]]`
If there is no version suffix, the main branch code template is used by default.
If there is a version suffix, the code template corresponding to the tag of this
version is used.
Example:
`wails init -n "Your Project Name" -t https://github.com/misitebao/wails-template-vue`
:::danger[Attention]
**The Wails project does not maintain, is not responsible nor liable for 3rd
party templates!**
If you are unsure about a template, inspect `package.json` and `wails.json` for
what scripts are run and what packages are installed.
:::
## Vue
- [wails-template-vue](https://github.com/misitebao/wails-template-vue) - Wails
template based on Vue ecology (Integrated TypeScript, Dark theme,
Internationalization, Single page routing, TailwindCSS)
- [wails-template-quasar-js](https://github.com/sgosiaco/wails-template-quasar-js) -
A template using JavaScript + Quasar V2 (Vue 3, Vite, Sass, Pinia, ESLint,
Prettier)
- [wails-template-quasar-ts](https://github.com/sgosiaco/wails-template-quasar-ts) -
A template using TypeScript + Quasar V2 (Vue 3, Vite, Sass, Pinia, ESLint,
Prettier, Composition API with &lt;script setup&gt;)
- [wails-template-naive](https://github.com/tk103331/wails-template-naive) -
Wails template based on Naive UI (A Vue 3 Component Library)
- [wails-template-nuxt](https://github.com/gornius/wails-template-nuxt) - Wails
template using clean Nuxt3 and TypeScript with auto-imports for wails js
runtime
- [Wails-Tool-Template](https://github.com/xisuo67/Wails-Tool-Template) - Wails
template using Vue+TypeScript+Vite+Element-plus(仿网易云)
## Angular
- [wails-template-angular](https://github.com/mateothegreat/wails-template-angular) -
Angular 15+ action packed & ready to roll to production.
- [wails-angular-template](https://github.com/TAINCER/wails-angular-template) -
Angular with TypeScript, Sass, Hot-Reload, Code-Splitting and i18n
## React
- [wails-react-template](https://github.com/AlienRecall/wails-react-template) -
A template using reactjs
- [wails-react-template](https://github.com/flin7/wails-react-template) - A
minimal template for React that supports live development
- [wails-template-nextjs](https://github.com/LGiki/wails-template-nextjs) - A
template using Next.js and TypeScript
- [wails-template-nextjs-app-router](https://github.com/thisisvk-in/wails-template-nextjs-app-router) -
A template using Next.js and TypeScript with App router
- [wails-template-nextjs-app-router-src](https://github.com/edai-git/wails-template-nextjs-app-router) -
A template using Next.js and TypeScript with App router src + example
- [wails-vite-react-ts-tailwind-template](https://github.com/hotafrika/wails-vite-react-ts-tailwind-template) -
A template for React + TypeScript + Vite + TailwindCSS
- [wails-vite-react-ts-tailwind-shadcnui-template](https://github.com/Mahcks/wails-vite-react-tailwind-shadcnui-ts) -
A template with Vite, React, TypeScript, TailwindCSS, and shadcn/ui
## Svelte
- [wails-svelte-template](https://github.com/raitonoberu/wails-svelte-template) -
A template using Svelte
- [wails-vite-svelte-template](https://github.com/BillBuilt/wails-vite-svelte-template) -
A template using Svelte and Vite
- [wails-vite-svelte-tailwind-template](https://github.com/BillBuilt/wails-vite-svelte-tailwind-template) -
A template using Svelte and Vite with TailwindCSS v3
- [wails-svelte-tailwind-vite-template](https://github.com/PylotLight/wails-vite-svelte-tailwind-template/tree/master) -
An updated template using Svelte v4.2.0 and Vite with TailwindCSS v3.3.3
- [wails-sveltekit-template](https://github.com/h8gi/wails-sveltekit-template) -
A template using SvelteKit
- [wails-template-shadcn-svelte](https://github.com/xijaja/wails-template-shadcn-svelte) -
A template using Sveltekit and Shadcn-Svelte
## Solid
- [wails-template-vite-solid-ts](https://github.com/xijaja/wails-template-solid-ts) -
A template using Solid + Ts + Vite
- [wails-template-vite-solid-js](https://github.com/xijaja/wails-template-solid-js) -
A template using Solid + Js + Vite
## Elm
- [wails-elm-template](https://github.com/benjamin-thomas/wails-elm-template) -
Develop your GUI app with functional programming and a **snappy** hot-reload
setup :tada: :rocket:
- [wails-template-elm-tailwind](https://github.com/rnice01/wails-template-elm-tailwind) -
Combine the powers :muscle: of Elm + Tailwind CSS + Wails! Hot reloading
supported.
## HTMX
- [wails-htmx-templ-chi-tailwind](https://github.com/PylotLight/wails-hmtx-templ-template) -
Use a unique combination of pure htmx for interactivity plus templ for
creating components and forms
## Pure JavaScript (Vanilla)
- [wails-pure-js-template](https://github.com/KiddoV/wails-pure-js-template) - A
template with nothing but just basic JavaScript, HTML, and CSS
## Lit (web components)
- [wails-lit-shoelace-esbuild-template](https://github.com/Braincompiler/wails-lit-shoelace-esbuild-template) -
Wails template providing frontend with lit, Shoelace component library +
pre-configured prettier and typescript.

View file

@ -129,8 +129,8 @@ app := application.New(application.Options{
})
```
:::tip[Why do the file extensions need to be set in the application config when
it's set in config.yml?]
<!-- prettier-ignore -->
:::tip[Why are file extensions required in both the application config and config.yml?]
On Windows, when a file is opened with a file association, the application is
launched with the filename as the first argument to the application. The

View file

@ -24,7 +24,6 @@ hero:
icon: heart
class:
- is-sponsor
---
import { Card, CardGrid } from "@astrojs/starlight/components";