This package is part of the
⚡storm-stack monorepo. The storm-stack packages include CLI utility applications, tools, and various libraries used to create modern, scalable web applications.
💻 Visit stormsoftware.org to stay up to date with this developer
[!IMPORTANT]
This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be availible through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.
Storm-Stack Nx Tools
A package containing tools for managing a Storm workspace. It includes various Nx generators and executors for common development tasks.
This library was generated with Nx.
Installing
Using pnpm:
pnpm add -D @storm-stack/nx-tools
Using npm
npm install -D @storm-stack/nx-tools
Using yarn
yarn add -D @storm-stack/nx-tools
Executors
The following executors are available in this package to invoke common tasks for the workspace's projects:
Storm-Stack Tamagui Compiler
Run the Tamagui compiler to correctly format react components for web and mobile
Example
This executor can be used by executing the following in a command line utility:
nx run my-project:tamagui
Please note: The tamagui executor should be included in the desired projects's project.json file.
Generators
The following generators are available with this package to assist in workspace management:
Building
Run nx build nx-tools to build the library.
Running unit tests
Run nx test nx-tools to execute the unit tests via Jest.
Storm Workspaces
Storm workspaces are built using Nx, a set of extensible dev tools for monorepos, which helps you develop like Google, Facebook, and Microsoft. Building on top of Nx, the Open System provides a set of tools and patterns that help you scale your monorepo to many teams while keeping the codebase maintainable.
Roadmap
See the open issues for a list of proposed features (and known issues).
Support
Reach out to the maintainer at one of the following places:
License
This project is licensed under the Apache License 2.0. Feel free to edit and distribute this template as you like.
See LICENSE for more information.
Changelog
This project adheres to Semantic Versioning. Every release, along with the migration instructions, is documented in the CHANGELOG file
Contributing
First off, thanks for taking the time to contribute! Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.
Please try to create bug reports that are:
- Reproducible. Include steps to reproduce the problem.
- Specific. Include as much detail as possible: which version, what environment, etc.
- Unique. Do not duplicate existing opened issues.
- Scoped to a Single Bug. One bug per report.
Please adhere to this project's code of conduct.
You can use markdownlint-cli to check for common markdown style inconsistency.
Contributors
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
Fingerprint: 1BD2 7192 7770 2549 F4C9 F238 E6AD C420 DA5C 4C2D
Storm Software is an open source software development organization and creator of Acidic, StormStack and StormCloud. Our mission is to make software development more accessible. Our ideal future is one where anyone can create software without years of prior development experience serving as a barrier to entry. We hope to achieve this via LLMs, Generative AI, and intuitive, high-level data modeling/programming languagues.
If this sounds interesting, and you would like to help us in creating the next generation of development tools, please reach out on our website!
💻 Visit stormsoftware.org to stay up to date with this developer
