Package Exports
Readme
This package is part of the ⚡Storm-Ops monorepo. The Storm-Ops packages include CLI utility applications, tools, and various libraries used to create modern, scalable web applications.
💻 Visit stormsoftware.com 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.
Table of Contents
Storm Configuration Package
A package containing the definition and Zod validation schema for the custom workspace configuration used by the Storm Software organization.
Below is a list of the available configuration values that can be set through environment variables:
| Name | Description | Default |
|---|---|---|
| STORM_COLOR_BACKGROUND | The workspace's background theme color | #1d1e22 |
| STORM_COLOR_FOREGROUND | The workspace's foreground theme color | #f4f4f5 |
| STORM_COLOR_BRAND | The workspace's primary brand specific color | #1fb2a6 |
| STORM_COLOR_ALTERNATE | The workspace's alternate brand specific color | null |
| STORM_COLOR_ACCENT | The workspace's secondary brand specific color | null |
| STORM_COLOR_LINK | The color used to display hyperlink text | null |
| STORM_COLOR_HELP | The workspace's help theme color | #8256D0 |
| STORM_COLOR_SUCCESS | The workspace's success theme color | #12B66A |
| STORM_COLOR_INFO | The workspace's informational theme color | #0070E0 |
| STORM_COLOR_WARNING | The workspace's warning theme color | #fcc419 |
| STORM_COLOR_DANGER | The workspace's danger theme color | #D8314A |
| STORM_COLOR_FATAL | The workspace's fatal theme color | null |
| STORM_COLOR_POSITIVE | The workspace's positive number color | #4ade80 |
| STORM_COLOR_NEGATIVE | The workspace's negative number color | #ef4444 |
| STORM_LOG_LEVEL | The logging level for the workspace | "info" |
| STORM_NAME | The name of the package | null |
| STORM_NAMESPACE | The namespace of the package | null |
| STORM_OWNER | The owner of the workspace | null |
| STORM_WORKER | The worker of the workspace | "stormie-bot" |
| STORM_ORG | The organization of the workspace | "storm-software" |
| STORM_PACKAGE_MANAGER | The package manager used in the workspace | "pnpm" |
| STORM_LICENSE | The license of the workspace | "Apache-2.0" |
| STORM_HOMEPAGE | The homepage of the workspace | https://stormsoftware.com |
| STORM_DOCS | The documentation URL of the workspace | null |
| STORM_LICENSING | The licensing information of the workspace | null |
| STORM_TIMEZONE | The timezone of the workspace | "America/New_York" |
| STORM_LOCALE | The locale of the workspace | "en-US" |
| STORM_CONFIG_FILE | The path to the configuration file | null |
| STORM_WORKSPACE_ROOT | The root directory of the workspace | null |
| STORM_PACKAGE_DIRECTORY | The directory where packages are stored | null |
| STORM_BUILD_DIRECTORY | The directory where build artifacts are stored | "dist" |
| STORM_SKIP_CACHE | Whether to skip caching | false |
| STORM_CACHE_DIRECTORY | The directory where cache is stored | "node_modules/.cache/storm" |
| STORM_RUNTIME_VERSION | The runtime version used in the workspace | null |
| STORM_OUTPUT_DIRECTORY | The directory where output files are stored | null |
| STORM_MODE | The environment mode type of the workspace | "production" |
| STORM_REPOSITORY | The repository URL of the workspace | null |
| STORM_BRANCH | The branch of the repository | "main" |
| STORM_PRE_ID | The pre-release identifier | null |
| STORM_EXTERNAL_PACKAGE_PATTERNS | The patterns for external packages | [] |
| STORM_CLOUDFLARE_ACCOUNT_ID | The Cloudflare account ID | null |
Installing
Using pnpm:
pnpm add -D @storm-software/configUsing npm
npm install -D @storm-software/configUsing yarn
yarn add -D @storm-software/configReduced Package Size
This project uses tsup to package the source code due to its ability to remove unused code and ship smaller javascript files thanks to code splitting. This helps to greatly reduce the size of the package and to make it easier to use in other projects.
Development
This project is built using Nx. As a result, many of the usual commands are available to assist in development.
Building
Run nx build config to build the library.
Running unit tests
Run nx test config to execute the unit tests via Jest.
Linting
Run nx lint config to run ESLint on the package.
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).
- Top Feature Requests (Add your votes using the 👍 reaction)
- Top Bugs (Add your votes using the 👍 reaction)
- Newest Bugs
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):
 Patrick Sullivan 🎨 💻 🔧 📖 ⚠️ |
 Tyler Benning 🎨 |
 Stormie 🚧 |
||||
Add your contributions
|
||||||
This project follows the all-contributors specification. Contributions of any kind welcome!
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 languages.
Join us on Discord to chat with the team, receive release notifications, ask questions, and get involved.
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 or join our Slack channel!
