stoatchat/awesome-stoat
1
0
Fork 0
mirror of https://github.com/stoatchat/awesome-stoat.git synced 2026-07-01 02:22:25 -04:00
Code Issues 2 Packages Projects Releases Wiki Activity

Initial Commit.

Browse Source
This commit is contained in:
Paul
2021-05-16 20:52:13 +01:00
parent be2b3b9b37
commit 71cc6a9e59
8 changed files with 68 additions and 138 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/lint.yaml
+8
View File
@@ -14,3 +14,11 @@ jobs:
uses: jthegedus/github-action-awesome-lint@v0.1.0 # I trust me, so will happily use Tag versioning over commit_sha
with:
args: ./readme-template.md
# Or use the below if you do not want to worry about security of someone else's GitHub Action contents.
- name: Setup node
uses: actions/setup-node@v1
with:
node-version: "12.x"
- run: |
npm install --global awesome-lint@latest
awesome-lint ./readme-template.md
ci/.gitlab-ci.yml → .gitlab-ci.yml
View File
ci/.circleci/config.yml
-31
View File
@@ -1,31 +0,0 @@
version: 2.1
jobs:
'awesome-bot':
docker:
- image: circleci/ruby:latest
steps:
- checkout
- run: gem install awesome_bot
- run: awesome_bot README.md --allow-redirect --allow-dupe
'awesome-lint':
docker:
- image: circleci/node:lts
steps:
- checkout
- restore_cache:
keys:
- yarn-packages
- run: yarn add awesome-lint
- save_cache:
key: yarn-packages
paths:
- ~/.cache/yarn
- run: yarn awesome-lint
workflows:
version: 2
build:
jobs:
- 'awesome-lint'
- 'awesome-bot'
ci/.github/workflows/lint.yaml
Vendored
-24
View File
@@ -1,24 +0,0 @@
name: Lint Awesome List
on: [pull_request, push]
jobs:
awesome-lint:
name: "lint: awesome-lint"
runs-on: ubuntu-latest
steps:
- name: "checkout repo"
uses: actions/checkout@v2.0.0
with:
fetch-depth: 0
- name: "lint: awesome-lint"
uses: jthegedus/github-action-awesome-lint@v0.1.0 # I trust me, so will happily use Tag versioning over commit_sha
with:
args: ./readme-template.md
# Or use the below if you do not want to worry about security of someone else's GitHub Action contents.
- name: Setup node
uses: actions/setup-node@v1
with:
node-version: "12.x"
- run: |
npm install --global awesome-lint@latest
awesome-lint ./readme-template.md
code_of_conduct.md
+1 -1
View File
@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at TODO_INSERT_YOUR_EMAIL_HERE. All
reported by contacting the project team at support@revolt.chat. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
contributing.md
+1 -1
View File
@@ -8,7 +8,7 @@ ALWAYS create a new branch with your proposed changes. Thank you!
## Adding an new Item
- Try to fit your item into an existing sections. [Open a suggestion](https://github.com/TODO_YOUR_REPO_NAME_HERE/issues/new) to start as discussion about any new sections.
- Try to fit your item into an existing sections. [Open a suggestion](https://github.com/insert/awesome-revolt/issues/new) to start as discussion about any new sections.
- Add a new item to the bottom of the list in a section.
- If a duplicate item exists, discuss why the new item should replace it.
- Check your spelling & grammar.
readme-template.md
-60
View File
@@ -1,60 +0,0 @@
<div align="center">
<!-- title -->
<!--lint ignore no-dead-urls-->
# Awesome List Template [![Awesome](https://awesome.re/badge.svg)](https://awesome.re) ![Lint Awesome List](https://github.com/<YOUR REPO>/awesome-<YOUR TOOL>/workflows/Lint%20Awesome%20List/badge.svg)
<!-- subtitle -->
A template for an awesome list with required conventions out of the box!
<!-- image -->
<!-- <a href="" target="_blank" rel="noopener noreferrer">
<img src="" />
</a> -->
<!-- description -->
A one line description of the product or tool. See [awesome-firebase](https://github.com/jthegedus/awesome-firebase) for an example.
</div>
<!-- TOC -->
## Contents
- [Featured (new releases)](#featured-new-releases)
- [Section 1](#section-1)
- [Follow](#follow)
<!-- CONTENT -->
## Featured (new releases)
- [Apple](https://apple.com) - Apple as a placeholder.
## Section 1
- [Microsoft](https://www.microsoft.com/) - Microsoft as an example.
<!-- END CONTENT -->
## Follow
<!-- list people worth following on social sites (twitter, linkedin, github, youtube etc.) -->
Who else should we be following!?
## Contributing
[Contributions of any kind welcome, just follow the guidelines](contributing.md)!
### Contributors
<!-- [Thanks goes to these contributors](https://github.com/TODO_YOUR_REPO_NAME_HERE/graphs/contributors)! -->
## License
[CC0 License](license)
readme.md
+58 -21
View File
@@ -1,27 +1,64 @@
# Awesome List Template
<div align="center">
This is an [awesome-list](https://github.com/sindresorhus/awesome) template with CI to run [awesome-lint](https://github.com/sindresorhus/awesome-lint) and [awesome_bot](https://github.com/dkhamsing/awesome_bot) to be compliant from the beginning.
<!-- title -->
## Usage
<!--lint ignore no-dead-urls-->
# Awesome Revolt [![Awesome](https://awesome.re/badge.svg)](https://awesome.re) ![Lint Awesome List](https://github.com/insertish/awesome-revolt/workflows/Lint%20Awesome%20List/badge.svg)
1. [generate a template of this repo](https://github.com/jthegedus/awesome-list-template/generate)
2. edit `readme-template.md`
- update the h1 title
- update the subtitle
- update the description
- add img src, make it link to the site of the thing in the image. uncomment the img code.
- update `TODO_YOUR_REPO_NAME_HERE` in the "contributors" link and uncomment the line
3. edit `code_of_conduct.md`
- update `TODO_INSERT_YOUR_EMAIL_HERE`
4. edit `contributing.md`
- update `TODO_YOUR_REPO_NAME_HERE`
5. choose a CI template
- github action: move config folver from `repo-root/ci/.github/` to `repo-root/.github`
- circle ci: move config folder from `repo-root/ci/.circleci/*` to `repo-root/.circleci/*`
- gitlab ci: move config file from `repo-root/ci/.gitlab-ci.yml` to the `repo-root/.gitlab-ci.yml`
6. delete this file
7. rename `readme-template.md` to `readme.md`
<!-- subtitle -->
An awesome list of things for the chat application Revolt.
<!-- image -->
<!-- <a href="https://revolt.chat" target="_blank" rel="noopener noreferrer">
<img src="https://revolt.chat/header.png" />
</a> -->
<!-- description -->
Revolt is a user-first, privacy-friendly chat platform built with modern web technologies.
</div>
<!-- TOC -->
## Contents
- [💻 API Libraries](#-api-libraries)
- [🤖 Bots](#-bots)
- [🔧 Third-party Clients](#-third-party-clients)
<!-- CONTENT -->
## 💻 API Libraries
- [**Node.js**: revolt.js](https://www.nuget.org/packages/Revolt.Net/) - Official Javascript library for Revolt.
- [**C#**: Revolt.NET](https://www.nuget.org/packages/Revolt.Net/) - The .NET library for Revolt with a DOD and OOP design.
- [**Java**: Java Revolt Bridge](https://github.com/jrvlt/jrv) - Experimental (version 0) Revolt API client for Java.
## 🤖 Bots
- [Taco](https://github.com/Jan0660/Taco) - Multi-purpose bot, includes Discord bridge and chat games.
- [Jan's Bot](https://gitea.janderedev.xyz/Jan/revolt-bot) - Generic Revolt bot made by Jan.
## 🔧 Third-party Clients
> These are not officially endorsed, **proceed at your own caution**.
- [**Minecraft:** Unofficial Fabric for Revolt](https://rvf.geist.ga/) - Minecraft-based client for the Revolt chat platform.
- [**Desktop App:** Electron Revolt Client by xFuney](https://github.com/xFuney/revolt-client) - Revolt desktop client built with Electron.
<!-- END CONTENT -->
## Contributing
Contributions welcome!
[Contributions of any kind welcome, just follow the guidelines](contributing.md)!
### Contributors
<!-- [Thanks goes to these contributors](https://github.com/insertish/awesome-revolt/graphs/contributors)! -->
## License
[CC0 License](license)