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.
Be sure to ⭐ this repository on GitHub so you can keep up to date on any daily progress!
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 | #1d232a |
STORM_COLOR_ERROR | The workspace's error theme color | #990000 |
STORM_COLOR_FATAL | The workspace's fatal theme color | #7d1a1a |
STORM_COLOR_INFO | The workspace's info theme color | #0ea5e9 |
STORM_COLOR_PRIMARY | The workspace's primary theme color | #1fb2a6 |
STORM_COLOR_SUCCESS | The workspace's success theme color | #087f5b |
STORM_COLOR_WARNING | The workspace's warning theme color | #fcc419 |
STORM_ENV | The current runtime environment of the package | "production" |
STORM_HOMEPAGE | The homepage URL for the workspace | https://stormsoftware.com |
STORM_LICENSE | The license used by the workspace | "Apache License 2.0" |
STORM_LOCALE | The default locale of the workspace | "en-US" |
STORM_LOG_LEVEL | The current maximum level of messages to write to the logs | "info" |
STORM_ORGANIZATION | The organization of the workspace | "storm-software" |
STORM_REPOSITORY | The repo URL of the workspace (i.e. GitHub URL) | |
STORM_RUNTIME_DIRECTORY | The default directory of the storm runtime for storage/generation | "node_modules/.storm" |
STORM_RUNTIME_VERSION | The global version of the Storm runtime | "1.0.0" |
STORM_TIMEZONE | The default timezone of the workspace | "America/New_York" |
STORM_BOT | The worker of the package (this is the bot that will be used to perform various tasks) | "stormie-bot" |
Installing
Using pnpm:
pnpm add -D @storm-software/config
Using npm
npm install -D @storm-software/config
Using yarn
yarn add -D @storm-software/config
Reduced 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).
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 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!