mirror of
https://github.com/tauri-apps/awesome-tauri.git
synced 2026-01-31 00:45:23 +01:00
Ready for contributions (#5)
This commit is contained in:
Jonas Kruckenberg
committed by
GitHub
GitHub
parent
7c8ed52c02
commit
8b12b09aa0
32
.github/contributing.md
vendored
Normal file
32
.github/contributing.md
vendored
Normal file
@@ -0,0 +1,32 @@
|
||||
# Contribution Guidelines
|
||||
|
||||
---
|
||||
|
||||
Ensure your pull request adheres to the following guidelines:
|
||||
|
||||
- Make sure you put things in the right category!
|
||||
- Always add your items to the end of a list. To be fair, the order is first-come-first-serve.
|
||||
- Do not use words that are clearly implied in the description, such as `for Tauri`, `a Tauri plugin`.
|
||||
- The description should be short (one sentence in 24 words, no expanded explanation) and meaningful without using emoji.
|
||||
- Do not use words that are not relevant to the description such as `Super-Fast` or `Super-Super-Fast`.
|
||||
- Don't start the description with `A` or `An`.
|
||||
- Make an individual pull request for each suggestion.
|
||||
- Use the following format: `[title](link) - Description.`
|
||||
- Check your spelling and grammar.
|
||||
- Make sure your text editor is set to remove trailing whitespace.
|
||||
- New categories or improvements to the existing categorization are welcome, but should be done in a separate pull request.
|
||||
|
||||
Thank you for your suggestion!
|
||||
|
||||
## Apps
|
||||
|
||||
Apps gives the opportunity to showcase the awesome things we can build with Tauri. When submitting your app, make sure it also adheres to the following:
|
||||
|
||||
- The app is using Tauri.
|
||||
- The app is original and not too simple.
|
||||
- Tauri goes to great lengths to enable fast, lightweight and secure apps. Therefore we expect featured apps to make a (reasonable) effort to be fast, lightweight and secure.
|
||||
- If you're submitting a closed source app, include evidence of it being built with Tauri.
|
||||
|
||||
## Violations
|
||||
|
||||
Please notice that entries that violate any of the above guidelines can be removed. We tend to be lenient and give you the benefit of the doubt, but spam, malware, projects not using tauri or repeat offenders will get removed.
|
||||
43
.github/pull_request_template.md
vendored
Normal file
43
.github/pull_request_template.md
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
- [ ] **I have read the [contributing guidelines](contributing.md).**
|
||||
|
||||
- [ ] Title as described.
|
||||
- [ ] Added to the right category.
|
||||
- [ ] Added to the end of a list.
|
||||
- [ ] The description of your item is a sentence with less than 24 words.
|
||||
- [ ] No links and parentheses in description.
|
||||
- [ ] The description starts with a capital and ends with a full stop/period.
|
||||
- [ ] The description doesn't start with `A` or `An`.
|
||||
- [ ] No unnecessary words already provided in the context (e.g. `for Tauri`, `a Tauri plugin`).
|
||||
- [ ] Uses proper case for terms (e.g. `GitHub`, `TypeScript`, `ESLint`, etc.)
|
||||
- [ ] When mentioning tools, omits versions whenever possible (e.g. use `TypeScript` instead of `TypeScript 4.x`.
|
||||
- [ ] When mentioning package names, uses quotes whenever possible.
|
||||
|
||||
### Plugins/Tools
|
||||
|
||||
<!-- Ignore if you are not contributing to Plugins/Tools -->
|
||||
|
||||
- [ ] The plugin/tool is working with **Tauri 1.x and onward**.
|
||||
- [ ] The project is Open Source.
|
||||
- [ ] The repo should be at least 30 days old.
|
||||
- [ ] The documentation is in English.
|
||||
- [ ] The project is active and maintained (inactive projects for longer 6 months will be removed without further notice).
|
||||
- [ ] The project accepts contributions.
|
||||
- [ ] Not a commercial product.
|
||||
|
||||
### Starter Templates
|
||||
|
||||
<!-- Ignore if you are not contributing to Starter Templates -->
|
||||
|
||||
- [ ] The starter template is working with **Tauri 1.x and onward**.
|
||||
- [ ] The documentation is in English.
|
||||
- [ ] The starter template most provide enough instructions / documentation about how to start up and what's is included.
|
||||
- [ ] The repo should be at least 30 days old.
|
||||
- [ ] Should be differentiable from the existing starter templates.
|
||||
|
||||
### Apps
|
||||
|
||||
<!-- Ignore if you are not contributing to Apps/Websites -->
|
||||
|
||||
- [ ] The project is Open Source.
|
||||
- [ ] The readme is in English.
|
||||
- [ ] The app is original and not too simple.
|
||||
15
.github/workflows/lint.yml
vendored
Normal file
15
.github/workflows/lint.yml
vendored
Normal file
@@ -0,0 +1,15 @@
|
||||
name: Lint
|
||||
on:
|
||||
push:
|
||||
pull_request:
|
||||
branches: [master]
|
||||
|
||||
jobs:
|
||||
lint:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- run: npm install
|
||||
- run: npm run lint
|
||||
4
.gitignore
vendored
Normal file
4
.gitignore
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
node_modules/
|
||||
package-lock.json
|
||||
yarn.lock
|
||||
pnpm-lock.yaml
|
||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2022 Tauri Apps Contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
71
README.md
71
README.md
@@ -1,33 +1,56 @@
|
||||
# AWESOME TAURI
|
||||
<!--lint disable awesome-heading awesome-github awesome-toc double-link -->
|
||||
|
||||
This is where we collect all of the best stuff from the ecosystem and community. To contribute, just make a PR.
|
||||
<h2 align='center'>Awesome Tauri</h2>
|
||||
|
||||
<p align='center'>
|
||||
This is where we collect all of the best stuff from the ecosystem and community.
|
||||
<br><br>
|
||||
|
||||
## Apps
|
||||
| App Name | Repo | Website | Description |
|
||||
| - | - | - | - |
|
||||
| | | |
|
||||
<a href='https://awesome.re'>
|
||||
<img src='https://awesome.re/badge-flat.svg' alt='Awesome'>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
## Table of Contents
|
||||
- [Get Started](#get-started)
|
||||
- [Plugins](#plugins)
|
||||
- [Integrations](#integrations)
|
||||
- [Apps](#apps)
|
||||
- [Tutorials](#tutorials)
|
||||
- [Articles](#articles)
|
||||
|
||||
## Get Started
|
||||
|
||||
- [Introduction](https://tauri.studio/docs/development/intro) - Official introduction to Tauri.
|
||||
- [create-tauri-app](https://github.com/tauri-apps/tauri/tree/next/tooling/create-tauri-app) - Rapidly scaffold your Tauri app.
|
||||
|
||||
### Templates
|
||||
|
||||
## Plugins
|
||||
| Plugin Name | Repo | Description |
|
||||
|-|-|-|
|
||||
| tauri-plugin-positioner | https://github.com/JonasKruckenberg/tauri-plugin-positioner | Helps positioning Tauri windows at known locations |
|
||||
| | |
|
||||
|
||||
## Templates
|
||||
| Template Name | Repo | Description |
|
||||
| - | - | - |
|
||||
| | |
|
||||
- [tauri-plugin-authenticator](https://github.com/tauri-apps/tauri-plugin-authenticator)  - Interface with hardware security keys.
|
||||
- [tauri-plugin-log](https://github.com/tauri-apps/tauri-plugin-log)  - Configurable logging.
|
||||
- [tauri-plugin-sql](https://github.com/tauri-apps/tauri-plugin-sql)  - Interface with SQL databases.
|
||||
- [tauri-plugin-store](https://github.com/tauri-apps/tauri-plugin-store)  - Persistent key value storage.
|
||||
- [tauri-plugin-stronghold](https://github.com/tauri-apps/tauri-plugin-stronghold)  - Encrypted, secure, p2p database.
|
||||
- [tauri-plugin-window-state](https://github.com/tauri-apps/tauri-plugin-window-state)  - Persist window sizes and positions.
|
||||
- [tauri-plugin-vibrancy](https://github.com/tauri-apps/tauri-plugin-vibrancy)  - Make your Tauri/TAO windows vibrant.
|
||||
- [tauri-plugin-shadows](https://github.com/tauri-apps/tauri-plugin-shadows)  - Add native shadows to your Tauri/TAO windows.
|
||||
- [tauri-plugin-positioner](https://github.com/JonasKruckenberg/tauri-plugin-positioner) - Move windows to common locations.
|
||||
|
||||
## Integrations
|
||||
|
||||
- [vue-cli-plugin-tauri](https://github.com/tauri-apps/vue-cli-plugin-tauri)  - Turn your Vue SPA into a lightweight cross-platform desktop app.
|
||||
- [vite-plugin-tauri](https://github.com/amrbashir/vite-plugin-tauri) - Integrate Tauri in a Vite project to build cross-platform apps.
|
||||
|
||||
## Apps
|
||||
|
||||
### Open Source
|
||||
|
||||
- [UsTaxes](https://github.com/ustaxes/ustaxes) - Free, private, open-source US tax filings.
|
||||
|
||||
### Closed Source
|
||||
|
||||
## Tutorials
|
||||
| Tutorial Name | Link | Description |
|
||||
| - | - | - |
|
||||
| | |
|
||||
|
||||
## Blog Articles
|
||||
| Article Name | Link | Description |
|
||||
| - | - | - |
|
||||
| | |
|
||||
|
||||
# License
|
||||
All content in this repo is licensed under [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/)
|
||||
## Articles
|
||||
|
||||
22
package.json
Normal file
22
package.json
Normal file
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"name": "awesome-tauri",
|
||||
"version": "1.0.0",
|
||||
"description": "<!-- <p align=\"center\"> <br> <img width=\"400\" src=\"./assets/logo.svg\" alt=\"logo of awesome-vite repository\"> <br> <br> </p> -->",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"lint": "awesome-lint README.md"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/tauri-apps/awesome-tauri.git"
|
||||
},
|
||||
"author": "",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/tauri-apps/awesome-tauri/issues"
|
||||
},
|
||||
"homepage": "https://github.com/tauri-apps/awesome-tauri#readme",
|
||||
"devDependencies": {
|
||||
"awesome-lint": "^0.18.0"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user