Skip to content

Latest commit

 

History

History
134 lines (89 loc) · 4.95 KB

README.md

File metadata and controls

134 lines (89 loc) · 4.95 KB
Raw

Starters

We like to reinvent the wheel... But smarter!



We do like to reinvent the wheel... But sometimes it's easier to start smarter with some previous work done! Starters is a collection of curated templates to help you kickstart your software projects with ease. What sets us apart is our unique capability to seamlessly update instances that are initiated using our starters. While other starter kits are primarily designed for initial project setup, we go a step further by ensures that your project incorporates the latest updates, including any new features added to the starter.

Starters Features

  • Quick Setup: Get your project up and running in minutes with our well-organized and pre-configured starter kits.
  • Seamless Updates: Unlike traditional starter kits, our templates come with a built-in update mechanism. Receive the latest enhancements and bug fixes effortlessly.
  • Customizable: Adapt the starters to fit your project's specific requirements. They serve as a foundation, not a rigid structure.

🚩 Table of Contents

🎮 Quick start

1. Choose a Starter from the following:

Starter Kit Description Documentation
cliroom 🐗 Build CLI interfaces for executing Zenroom smart contracts 📄 Documentation
saas 🚀 Full-featured PWA/SaaS webapp, including Slangroom integration 📄 Documentation
ts-sea 🪑 Template to create single executable applications using TypeScript 📄 Documentation
typescript 🛕 Monorepo generic template for TypeScript projects 📄 Documentation
go 🐹 Generic template for Golang projects 📄 Documentation

2. Create your instance by executing

cruft create https://github.com/dyne/starters --directory {your_choosen_starter}

3. Benefit from automatic updates by regularly checking for the latest releases and applying them to your project by running inside the rootfolder of your generated app

cruft update

🔝 back to top

🚑 Community & support

📝 Documentation - Getting started and more.

🚩 Issues - Bugs end errors you encounter using Starters.

[] Matrix - Hanging out with the community.

🗣️ Discord - Hanging out with the community.

🪁 Telegram - Hanging out with the community.

🔝 back to top

😍 Acknowledgements

Copyleft 🄯 2023 by Dyne.org foundation, Amsterdam

This repo takes inspiration from https://github.com/spinspire/recipes but in place of degitting everywhere sometimes more inclined to ease the project creation with cruft.

Designed, written and maintained by Dyne's hackers.

🔝 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

Starters - We like reinvent the wheel... But smarter!
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