Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add community page(s) #3941

Merged
merged 13 commits into from
Dec 9, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
save-exact=true
15 changes: 15 additions & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -100,6 +102,19 @@ export default defineConfig({
collapsed: true,
autogenerate: { directory: "api", collapsed: true },
},
{
label: "Community",
collapsed: true,
items: [
{
label: "Showcase",
autogenerate: {
directory: "community/showcase",
collapsed: true,
},
},
],
},
{
label: "Development",
collapsed: true,
Expand Down
1,150 changes: 398 additions & 752 deletions docs/package-lock.json

Large diffs are not rendered by default.

13 changes: 7 additions & 6 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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 added docs/src/assets/showcase-images/bboard.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/cfntracker.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/emailit.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/encrypteasy.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/esp-studio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase-images/filehound.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/hiposter.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/mac-app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase-images/mchat.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/src/assets/showcase-images/mollywallet.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/october.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/optimus.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/portfall.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/resizem.webp
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file added docs/src/assets/showcase-images/scriptbar.webp
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase-images/surge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase-images/tiny-rdm1.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/tiny-rdm2.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/varly2.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/wailsterm.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/wally.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/warmine1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase-images/warmine2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase-images/wombat.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/ytd.webp
Binary file not shown.
16 changes: 16 additions & 0 deletions docs/src/content/docs/community/showcase/bulletinboard.md
Original file line number Diff line number Diff line change
@@ -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).
36 changes: 36 additions & 0 deletions docs/src/content/docs/community/showcase/cfntracker.md
Original file line number Diff line number Diff line change
@@ -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
stavros-k marked this conversation as resolved.
Show resolved Hide resolved
- [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
14 changes: 14 additions & 0 deletions docs/src/content/docs/community/showcase/emailit.md
Original file line number Diff line number Diff line change
@@ -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. It’s built using Wails2 and Svelte, and the
download is a universal macOS application.
16 changes: 16 additions & 0 deletions docs/src/content/docs/community/showcase/encrypteasy.md
Original file line number Diff line number Diff line change
@@ -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.
9 changes: 9 additions & 0 deletions docs/src/content/docs/community/showcase/espstudio.md
Original file line number Diff line number Diff line change
@@ -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
29 changes: 29 additions & 0 deletions docs/src/content/docs/community/showcase/filehound.md
Original file line number Diff line number Diff line change
@@ -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
8 changes: 8 additions & 0 deletions docs/src/content/docs/community/showcase/hiposter.md
Original file line number Diff line number Diff line change
@@ -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.
159 changes: 159 additions & 0 deletions docs/src/content/docs/community/showcase/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
---
title: Overview
sidebar:
order: 1
---

import { ShowcaseImage } from "starlight-showcases";

<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/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",
},
]}
/>
8 changes: 8 additions & 0 deletions docs/src/content/docs/community/showcase/mchat.md
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 10 additions & 0 deletions docs/src/content/docs/community/showcase/minecraftupdater.md
Original file line number Diff line number Diff line change
@@ -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. It’s
built using Wails2 and React with [antd](https://ant.design/) as frontend
framework.
8 changes: 8 additions & 0 deletions docs/src/content/docs/community/showcase/minesweeper-xp.md
Original file line number Diff line number Diff line change
@@ -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!
21 changes: 21 additions & 0 deletions docs/src/content/docs/community/showcase/modalfilemanager.md
Original file line number Diff line number Diff line change
@@ -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
stavros-k marked this conversation as resolved.
Show resolved Hide resolved
[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.
Loading