Skip to content

Commit

Permalink
awesome-lint nitpicks
Browse files Browse the repository at this point in the history
  • Loading branch information
CurlyBracketEffect committed Sep 30, 2020
1 parent d60befc commit bead0ab
Show file tree
Hide file tree
Showing 2 changed files with 94 additions and 80 deletions.
160 changes: 80 additions & 80 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,12 @@
-[Developer Resources: Awesome Lists](https://codeburst.io/developer-resources-awesome-lists-2c85b45a0216)

This is the official **Awesome List** for [Substrate](https://substrate.io/); it is maintained by
the [Substrate Developer Hub](https://substrate.dev/) team.
This is the official **Awesome List** for Substrate, it is maintained by the Substrate Developer Hub
team.

## What is Substrate?

Substrate is a framework for building upgradable, modular and efficient blockchains. Substrate is an
[open-source](https://github.com/paritytech/substrate) library of [Rust](https://www.rust-lang.org/)
code that is maintained by [Parity Technologies](https://www.parity.io/).

## Table of Contents
## Contents

- [What Substrate is](#what-substrate-is)
- [Official Resources](#official-resources)
- [Recordings](#recordings)
- [Workshops & Demos](#workshops--demos)
Expand All @@ -30,29 +25,35 @@ code that is maintained by [Parity Technologies](https://www.parity.io/).
- [Client Libraries](#client-libraries)
- [Ecosystem Tools](#ecosystem-tools)

## What Substrate is

Substrate is a framework for building upgradable, modular and efficient blockchains. Substrate is an
open-source library of [Rust](https://www.rust-lang.org/) code that is maintained by
[Parity Technologies](https://www.parity.io/).

## Official Resources

- [substrate.io](https://substrate.io/) - Product page
- [Developer Hub](https://substrate.dev/) - Developer portal
- [Tutorials](https://substrate.dev/tutorials) - Guided exercises to get you started
- [substrate.io](https://substrate.io/) - Product page.
- [Developer Hub](https://substrate.dev/) - Developer portal.
- [Tutorials](https://substrate.dev/tutorials) - Guided exercises to get you started.
- [Knowledge Base](https://substrate.dev/knowledgebase) - In-depth documentation related to
Substrate development
- [Recipes](https://substrate.dev/recipes) - Working code examples that solve common problems
- [Reference Docs](https://substrate.dev/rustdocs) - Rustdoc API documentation
Substrate development.
- [Recipes](https://substrate.dev/recipes) - Working code examples that solve common problems.
- [Reference Docs](https://substrate.dev/rustdocs) - Rustdoc API documentation.
- [Seminar](https://substrate.dev/seminar) - Collaborative learning on
[Crowdcast](https://www.crowdcast.io/e/substrate-seminar)
- [Technical Chat](https://app.element.io/#/room/!HzySYSaIhtyWrwiwEV:matrix.org) - Ask questions &
chat with other Substrate developers
- [Builders Program](https://www.substrate.io/builders-program) - white-glove support for visionary
teams
- [Web3 Foundation Grants](https://web3.foundation/grants) - funding for ecosystem development
- [Users](https://www.substrate.io/substrate-users) - Teams building with Substrate
- [GitHub](https://github.com/paritytech/substrate) - Substrate source code
- [Developer Hub GitHub](https://github.com/substrate-developer-hub/) - Developer Hub repositories
chat with other Substrate developers.
- [Builders Program](https://www.substrate.io/builders-program) - White-glove support for visionary
teams.
- [Web3 Foundation Grants](https://web3.foundation/grants) - Funding for ecosystem development.
- [Users](https://www.substrate.io/substrate-users) - Teams building with Substrate.
- [GitHub](https://github.com/paritytech/substrate) - Substrate source code.
- [Developer Hub GitHub](https://github.com/substrate-developer-hub/) - Developer Hub repositories.
- [Polkadot GitHub](https://github.com/paritytech/polkadot) - Substrate monorepo for multiple
Parity-sponsored chains
- [Parity Blog](https://www.parity.io/blog/) - Read about updates in the Substrate ecosystem
- [Twitter](https://twitter.com/substrate_io) - Follow us to stay up-to-date
Parity-sponsored chains.
- [Parity Blog](https://www.parity.io/blog/) - Read about updates in the Substrate ecosystem.
- [Twitter](https://twitter.com/substrate_io) - Follow us to stay up-to-date.

## Recordings

Expand All @@ -66,100 +67,99 @@ code that is maintained by [Parity Technologies](https://www.parity.io/).
## Workshops & Demos

- [UTXO Workshop](https://github.com/substrate-developer-hub/utxo-workshop) - Use Substrate to
implement a Bitcoin-like chain
- [Cumulus Wokshop](https://substrate.dev/cumulus-workshop/#/) - Build a parachain with Cumulus
implement a Bitcoin-like chain.
- [Cumulus Wokshop](https://substrate.dev/cumulus-workshop/#/) - Build a parachain with Cumulus.
- [Enterprise Sample](https://github.com/substrate-developer-hub/substrate-enterprise-sample) - A
fully-featured sample that uses a supply chain use case to demonstrate Substrate's rich set of
capabilities
capabilities.

## Community Resources

- [DotLeap](https://dotleap.com/) - Community content and newsletter
- [DotLeap](https://dotleap.com/) - Community content and newsletter.
- [Stack Overflow](https://stackoverflow.com/questions/tagged/substrate) - Questions tagged
`substrate`
- [Reddit](https://www.reddit.com/r/substrate/) - Official subreddit
- [Polkadot Stack](https://github.com/w3f/General-Grants-Program/blob/master/grants/polkadot_stack.md) -
Another awesome list maintained by our friends at [Web3 Foundation](https://web3.foundation/)
- [Subsocial](https://subsocial.network/) - Decentralized social network for Polkadot / Kusama ecosystem. Built on Substrate + IPFS.
`substrate`.
- [Reddit](https://www.reddit.com/r/substrate/) - Official subreddit.
- [Polkadot Stack](https://github.com/w3f/General-Grants-Program/blob/master/grants/polkadot_stack.md) - Another
awesome list maintained by our friends at [Web3 Foundation](https://web3.foundation/).
- [Subsocial](https://subsocial.network/) - Decentralized social network for the Polkadot / Kusama
ecosystem. Built on Substrate + IPFS.

## Frameworks

- [FRAME](https://substrate.dev/docs/en/knowledgebase/runtime/frame) - An idiomatic system for
building Substrate runtimes
- [ink!](https://github.com/paritytech/ink) - Smart contract language for Substrate chains
- [Cumulus](https://github.com/paritytech/cumulus) - Simplified Polkadot-compatible parachains
building Substrate runtimes.
- [ink!](https://github.com/paritytech/ink) - Smart contract language for Substrate chains.
- [Cumulus](https://github.com/paritytech/cumulus) - Simplified Polkadot-compatible parachains.
- [Bridges](https://github.com/paritytech/parity-bridges-common) - A collection of tools for
cross-chain communication
cross-chain communication.
- [Frontier](https://github.com/paritytech/frontier) - End-to-end Ethereum emulation for Substrate
chains
- [Polkadot-JS](https://polkadot.js.org/) - Rich framework for front-end development
chains.
- [Polkadot-JS](https://polkadot.js.org/) - Rich framework for front-end development.
- [SubstraTEE](https://www.substratee.com) - Trusted off-chain execution framework that uses
[Intel SGX](https://en.wikipedia.org/wiki/Software_Guard_Extensions) trusted execution
environments
environments.

## Templates

- [Node](https://github.com/substrate-developer-hub/substrate-node-template) - A fresh
[FRAME](https://substrate.dev/docs/en/knowledgebase/runtime/frame)-based node, ready for hacking
- [Node](https://github.com/substrate-developer-hub/substrate-node-template) - A fresh FRAME-based
node, ready for hacking.
- [Pallet](https://github.com/substrate-developer-hub/substrate-pallet-template) - Easily create
pluggable blockchain capabilities
pluggable blockchain capabilities.
- [Parachain](https://github.com/substrate-developer-hub/substrate-parachain-template) - A new
[Cumulus](https://github.com/paritytech/cumulus)-based Substrate node, ready for hacking
Cumulus-based Substrate node, ready for hacking (see 'Cumulus' under Frameworks for more info).
- [Front-End](https://github.com/substrate-developer-hub/substrate-front-end-template) - Use the
[Polkadot-JS API](https://github.com/polkadot-js/api/) and [React](https://reactjs.org/) to build
front-ends for Substrate-based chains
Polkadot-JS API and [React](https://reactjs.org/) to build front-ends for Substrate-based chains.

## Pallets

- [Open Runtime Module Library (ORML)](https://github.com/open-web3-stack/open-runtime-module-library) -
Community maintained collection of Substrate runtime modules
- [Sunshine Bounty](https://github.com/sunshine-protocol/sunshine-bounty/tree/master/pallets) -
Distributed autonomous organization (DAO) for administering a bounty program
- [Sunshine Identity](https://github.com/sunshine-protocol/sunshine-keybase/tree/master/identity/pallet) -
Keybase-inspired identity management
- [Sunshine Faucet](https://github.com/sunshine-protocol/sunshine-keybase/tree/master/faucet/pallet) -
Dispense resources for a development chain
- [Open Runtime Module Library (ORML)](https://github.com/open-web3-stack/open-runtime-module-library) - Community
maintained collection of Substrate runtime modules.
- [Sunshine Bounty](https://github.com/sunshine-protocol/sunshine-bounty/tree/master/pallets) - Distributed
autonomous organization (DAO) for administering a bounty program.
- [Sunshine Identity](https://github.com/sunshine-protocol/sunshine-keybase/tree/master/identity/pallet) - Keybase-inspired
identity management.
- [Sunshine Faucet](https://github.com/sunshine-protocol/sunshine-keybase/tree/master/faucet/pallet) - Dispense
resources for a development chain.
- [Commodities](https://github.com/danforbes/pallet-nft) - Defines and implements a non-fungible
token interface
token interface.

## Client Libraries

- [`subxt`](https://github.com/paritytech/substrate-subxt) - Official Rust client
- [`subxt`](https://github.com/paritytech/substrate-subxt) - Official Rust client.
- [Substrate API Client](https://github.com/scs/substrate-api-client) - Rust client maintained by
[Supercomputing Systems AG](https://www.scs.ch/)
- [Polkadot-JS API](https://github.com/polkadot-js/api/) - Semi-official Javascript library for
Substrate-based chains
[Supercomputing Systems AG](https://www.scs.ch/).
- [Polkadot-JS API](https://github.com/polkadot-js/api/) - Semi-official JavaScript library for
Substrate-based chains.
- [Python Substrate Interface](https://github.com/polkascan/py-substrate-interface) - Maintained by
[Polkascan Foundation](https://polkascan.org/)
[Polkascan Foundation](https://polkascan.org/).
- [Go Substrate RPC Client](https://github.com/centrifuge/go-substrate-rpc-client/) - Maintained by
[Centrifuge](https://centrifuge.io/)
[Centrifuge](https://centrifuge.io/).
- [Substrate C++ API](https://github.com/usetech-llc/polkadot_api_cpp) - Maintained by
[Usetech](https://usetech.com/blockchain/)
- [Substrate .Net API](https://github.com/usetech-llc/polkadot_api_dotnet) - Maintained by
[Usetech](https://usetech.com/blockchain/)
[Usetech](https://usetech.com/blockchain/).
- [Substrate .Net API](https://github.com/usetech-llc/polkadot_api_dotnet) - Maintained by Usetech.

## Ecosystem Tools

- [Polkadot-JS Apps UI](https://polkadot.js.org/apps/) - Semi-official block explorer & front-end
for Substrate-based chains
for Substrate-based chains.
- [Polkadot-JS Extension](https://github.com/polkadot-js/extension) - Browser extension for
interacting with Substrate-based chains
interacting with Substrate-based chains.
- [Sidecar](https://github.com/paritytech/substrate-api-sidecar) - REST service that runs alongside
Substrate nodes
- [Archive](https://github.com/paritytech/substrate-archive) - Indexing engine for Substrate chains
Substrate nodes.
- [Archive](https://github.com/paritytech/substrate-archive) - Indexing engine for Substrate chains.
- [TxWrapper](https://github.com/paritytech/txwrapper) - Helpful library for offline transaction
creation
creation.
- [Subkey](https://substrate.dev/docs/en/knowledgebase/integrate/subkey) - Command line utility for
working with cryptographic keys
- [Polkascan](https://polkascan.io/) - Multi-chain block explorer maintained by
[Polkascan Foundation](https://polkascan.org/)
- [VSCode Substrate](https://marketplace.visualstudio.com/items?itemName=paritytech.vscode-substrate) -
Official plugin for Visual Studio Code
working with cryptographic keys.
- [Polkascan](https://polkascan.io/) - Multi-chain block explorer maintained by Polkascan
Foundation.
- [VSCode Substrate](https://marketplace.visualstudio.com/items?itemName=paritytech.vscode-substrate) - Official
plugin for Visual Studio Code.
- [Parity Signer](https://www.parity.io/signer/) - Upcycle an unused mobile phone into an air-gapped
hardware wallet
hardware wallet.
- [Fork Off Substrate](https://github.com/maxsam4/fork-off-substrate) - Script to help bootstrap a
new chain with the state of a running chain
new chain with the state of a running chain.
- [Substrate debug-kit](https://github.com/paritytech/substrate-debug-kit) - A collection of tools
and libraries for debugging Substrate-based chains, including
[`offline-election`](https://github.com/paritytech/substrate-debug-kit/tree/master/offline-election),
which is a tool that is used to predict nominated proof-of-stake elections.
and libraries for debugging Substrate-based chains, including
[`offline-election`](https://github.com/paritytech/substrate-debug-kit/tree/master/offline-election),
which is a tool that is used to predict nominated proof-of-stake elections.
14 changes: 14 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Contribution Guidelines

Please ensure your pull request adheres to the following guidelines:

- Search previous suggestions before making a new one, as yours may be a duplicate.
- Make an individual pull request for each suggestion.
- Use the following format: `[Topic](LINK) - DESCRIPTION.`
- New categories, or improvements to the existing categorization are welcome.
- Keep descriptions short and simple, but descriptive.
- End all descriptions with a full stop/period.
- Check your spelling and grammar.
- Make sure your text editor is set to remove trailing whitespace.

Thank you for your suggestions!

0 comments on commit bead0ab

Please sign in to comment.