EXPLORE THE WIKI

Report Error · Request Topic

Table of Contents

• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Local Development
• Contributing
• Contact

About the Project

The IOTA Wiki is a central hub for entering into the IOTA ecosystem. A community driven initiative to provide an up-to-date collection of introductions and further reading about the technology, the teams, the community, and everything in between. So anyone can learn how to build, adopt, and engage with IOTA, all in one space.

Built With

The IOTA Wiki is built using TypeScript, ReactJS and Docusaurus v2.0.

Getting Started

Prerequisites

• git 1.8.2 or above.
• Node.js 16.10 or above.
• Modern Yarn enabled by running corepack enable.

Preview Locally

Because the Wiki is a large project composed of several Docusaurus builds and external documentation, a full build takes a while. To speed up development, we provide environment variables to select different configurations, and some convenience scripts with environment variables pre-configured.

To preview the entire Wiki locally, use the following steps. For more selective preview and build configurations, see Environment variables and Pre-configured scripts for reference.

1. Clone the repository by running git clone https://github.com/iota-wiki/iota-wiki.git and go to the directory with cd iota-wiki.
2. Install dependencies with yarn.
3. Check out the latest version of external documentation with yarn checkout:remote.
4. Build all environments including external documentation and serve the result with EXTERNAL="*,*/*,*/*/*" yarn start:all.

Environment variables

Variable	Accepts	Default	Explanation
ENVIRONMENT	One of iota, shimmer, or next	iota	The environment to build.
EXTERNAL	A comma separated list of glob patterns		What external documentation to include in the build. Glob patterns are relative to the <environment>/external directories.
MODE	One of development, or production	development	Depending on the mode chosen, some functionalities are included or excluded (analytics for example).

For example ENVIRONMENT=iota EXTERNAL=identity.rs/**,wallet.rs/** yarn start starts a development server for the iota environment with all identity.rs and wallet.rs versions included.

Pre-configured scripts

Script	Explanation
start:<environment>	Start a development server for the iota, shimmer, or next environment, with hot reloading on changes.
start:all	Build all environments and serve the result, without hot reloading on changes.
build:<environment>	Build the iota, shimmer, or next environment.
build:all	Build all environments.
checkout	Check out external documentation.
checkout:<environment>	Check out external documentation for the iota, shimmer, or next environment.
checkout:remote:<environment>	Check out the latest version of external documentation.
checkout:remote	Check out the latest version of external documentation for the iota, shimmer, or next environment.
generate:api	Generate available API documentation configured through the Docusaurus OpenAPI plugin.

For example EXTERNAL=identity.rs/**,wallet.rs/** yarn start:iota starts a development server for the iota environment with all identity.rs and wallet.rs versions included.

Contributing

The IOTA Wiki is maintained by the community. We will review all issues and pull requests posted to this repository. If you notice any mistakes, or feel something is missing, feel free to create an issue to discuss with the team or directly create a pull request with suggestions. Here is a basic workflow to open a pull request:

1. Fork this repository to your own account and clone it (git clone https://github.com/<YOUR_USERNAME>/iota-wiki.git)
2. Create a feature branch for your changes (git checkout -b feat/amazing-feature).
3. Make your changes and optionally preview them locally.
4. Run yarn lint and yarn format and fix any remaining errors and warnings.
5. Commit your changes (git commit -m 'Add some amazing feature').
6. Push your changes to your fork (git push origin feat/amazing-feature).
7. Open a pull request to the main branch of this repository.

Have a look at CONTRIBUTING for further guidance.

Online one-click setup for contributing

You can use Gitpod (a free, online, VS Code-like IDE) for contributing. With a single click it will prepare everything you need to build and contribute to the Wiki. Just click on this button and skip step 1 from above.

Contact

Phylo - Phyloiota - Phylo [Community DAO - lets go!]#2233
Jeroen van den Hout - jlvandenhout - jvdhout#4402
Dr.Electron - Dr-Electron - Dr.Electron#9370
Critical - Critical94 - Critical#7111
JSto - JSto91 - JSto#3746

Donate

The IOTA Wiki is a completely voluntary project put together, maintained, and contributed to by a group of enthusiastic community members. Feel free to support our work:

iota1qzrmyrnfhfauhv6gax50ncx844uppq4c5dddp3gk99ha0lx5jeqkwk6dapx