Readme update : contribute

[jeemclr]

Ternoa Documentation

All resources you'll need to build the future on Ternoa
Explore the docs »

View Demo · Report Bug · Discussions

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage Examples
4. Docmap
5. Contributing
6. Contact
7. Acknowledgments

About Ternoa

In 2018, the idea of Ternoa was born with the objective to create a technology that can store data forever, make it accessible only to its owner, and pass it along through time. After two years of R&D, Ternoa was launched in November 2020.

We've chosen the Polkadot ecosystem to develop our own blockchain to meet our requirements. Starting from Substrate, we've developed an innovative NFT we call "Capsule". This new NFT technology gives users a unique way to use NFT as proprietary decentralized data storage.

Our Non-Fungible Token (NFT) innovations helped us create a protocol dedicated to NFTs on the Polkadot ecosystem.

Today, Ternoa develops all NFTs basics on the Polkadot ecosystem, enabling innovative solutions.

Read our LitePaper

(back to top)

Built With

• Node JS
• Polkadot-JS API
• AXIOS
• BigNum JS
• Form-Data
• mime-types

(back to top)

Getting Started

To work and contribute on our documentation, you can clone our repo and run Docusaurus 2 following the instructions below.

Prerequisites

npm install yarn@latest -g

Installation

Ternoa Documentation is built using Docusaurus 2, a modern static website generator.

Init Project

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

(back to top)

Usage Examples

You can find useful examples of usecases. Additional screenshots, code examples, demos or links to more resources from the Ternoa community. We will highlight community works soon.

For your first examples you can check our CookBook

Time Capsule dApp is our most relevant use case on the Ternoa blockchain, check out here

For more examples, please refer to the Wiki

(back to top)

Docmap

• Ternoa Fundamentals
  • Core Blockchain
  • Offchain Components
  • TEE Enclaves
  • Ternoa NFT Primitives
  • Staking
• For Developers
  • Ternoa-JS SDK
  • Indexer
• For Node Operators

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the Ternoa community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have ideas or if you want to help by contributing to Ternoa Documentation, please fork the repo and create a pull request. You can also simply open an issue with the tag "Idea Proposal".
Don't forget to give the project a star ! Thanks again Fam !

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingTernoaFeature)
3. Commit your Changes (git commit -m 'Add some AmazingTernoaFeature')
4. Push to the Branch (git push origin feature/AmazingTernoaFeature)
5. Open a Pull Request

(back to top)

Contact

Capsule Corp Labs - @Ternoa_ - support@ternoa.com

Project Link: Ternoa SDK

(back to top)

Acknowledgments

(back to top)

[Balianos]

First Needs :

Explain what the idea of the Ternoa Doc
Having an automated list of contributors
Start talking about contributions