Skip to content

Latest commit

 

History

History
162 lines (102 loc) · 4.39 KB

README.md

File metadata and controls

162 lines (102 loc) · 4.39 KB
Raw

cliroom

🛠️ CLI builder that runs Zencode smart contracts



cliroom features

asciicast


🚩 Table of Contents

🎮 Quick start

Cliroom is a template of a project that allows you to create beatufil command line interfaces based on Zencode smart contracts.

To start using cliroom

  1. cruft create --directory cliroom https://github.com/dyne/starters
  2. answer questions (suppose to name your project myproject)
  3. cd myproject
  4. edit package.json and change the name and description
  5. populate the contracts folder with your zencode smart contracts
  6. define the parameters of your contracts with *.param files
  7. npm i && npm build
  8. 🎉 enjoy your new CLI

🔝 back to top

🚑 Community & support

📝 Documentation - Getting started and more.

🌱 Ecosystem - Plugins, resources, and more.

🚩 Issues - Bugs end errors you encounter using cliroom.

💬 Discussions - Get help, ask questions, request features, and discuss cliroom.

[] Matrix - Hanging out with the community.

🗣️ Discord - Hanging out with the community.

🪁 Telegram - Hanging out with the community.

📖 Example - An example repository that uses cliroom.

🔝 back to top

 Roadmap

  • cookiecutter
  • restroom integration
  • test stdin
  • files params arguments
  • args & opts validation
  • girhub action build and release of the binaries
  • documentation & tutorials

🔧 Configuration

🔝 back to top

🐛 Troubleshooting & debugging

If you find some bug please report it 🚩 Issues

If you are looking for guidance hang out with the community on [] Matrix or 🗣️ Discord -

If there are some known problem we will write it down here.

🔝 back to top

😍 Acknowledgements

Copyleft 🄯 2023 by Dyne.org foundation, Amsterdam

Designed, written and maintained by Puria Nafisi Azizi.

🔝 back to top

👤 Contributing

Please first take a look at the Dyne.org - Contributor License Agreement then

  1. 🔀 FORK IT
  2. Create your feature branch git checkout -b feature/branch
  3. Commit your changes git commit -am 'feat: New feature\ncloses #398'
  4. Push to the branch git push origin feature/branch
  5. Create a new Pull Request gh pr create -f
  6. 🙏 Thank you

🔝 back to top

💼 License

cliroom - 🛠️ CLI builder that runs Zencode smart contracts
Copyleft 🄯 2023 Dyne.org foundation, Amsterdam

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

🔝 back to top