An open API service indexing awesome lists of open source software.

https://github.com/storm-software/powerlines

🔌 The "framework framework" that simplifies modern dev tool usage, generates virtual (or actual) code modules, and improves DX across the board.
https://github.com/storm-software/powerlines

babel deepkit developer-tools esbuild rolldown typedoc unplugin vite

Last synced: 2 days ago
JSON representation

🔌 The "framework framework" that simplifies modern dev tool usage, generates virtual (or actual) code modules, and improves DX across the board.

Awesome Lists containing this project

README

          



Powerlines





Website
GitHub
DiscordDocsContact
Report a Bug



**🔌 Powerlines** is a "framework framework" that simplifies modern development tool usage, generates virtual (or actual) code modules, and improves DX across the board.

💻 Visit stormsoftware.com to stay up to date with this developer



[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/) ![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6) ![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/powerlines/release.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)

> [!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 available 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

- [Getting Started](#getting-started)
- [Environment Configuration Help](#environment-configuration-help)
- [Build](#build)
- [Development Server](#development-server)
- [Environment Configuration Help](#environment-configuration-help-1)
- [Plug-Ins](#plug-ins)
- [Generate an Application](#generate-an-application)
- [Generate a Library](#generate-a-library)
- [Code Scaffolding](#code-scaffolding)
- [Testing](#testing)
- [Running Unit Tests](#running-unit-tests)
- [Running End-to-End Tests](#running-end-to-end-tests)
- [Understand your workspace](#understand-your-workspace)
- [☁ Nx Cloud](#-nx-cloud)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [Support](#support)
- [License](#license)
- [Contributors ✨](#contributors-)


# Getting Started

Once the code is pulled locally, open a command prompt and run `pnpm install` in
the root repo directory (/powerlines).

More information can be found in the
[Powerlines documentation](https://storm-software.github.io/powerlines/docs/getting-started/installation).

[ Back to top ▲ ]


## Environment Configuration Help

If you run into any issues while trying to run any of the above steps, please
reach out to Patrick Sullivan. See the [Support](#support) section for more
information.

## Build

Run `pnpm build` to build the project. The build artifacts will be stored in the
`dist/` directory. Use the `--prod` flag for a production build.

[ Back to top ▲ ]


## Development Server

Run `pnpm serve` for a dev server. Navigate to . The app
will automatically reload if you change any of the source files.

[ Back to top ▲ ]


# Environment Configuration Help

If you run into any issues while trying to run any of the above steps, please
reach out to Patrick Sullivan. See the [Support](#support) section for more
information.

[ Back to top ▲ ]


## Plug-Ins

Some of the plug-ins used by this repository are:

- [@nx/next](https://nx.dev/packages/next)
- [@nx/react](https://nx.dev/packages/react)
- [@nx/lint](https://nx.dev/linter/overview)
- [@nx/js](https://nx.dev/js/overview)
- [@nx/node](https://nodejs.org)
- [@nx/web](https://nx.dev/web/overview)
- [@nx/storybook](https://nx.dev/storybook/overview-react)
- [@nx/cypress](https://nx.dev/packages/cypress)
- [@nx/jest](https://nx.dev/packages/jest)
- And more...

[ Back to top ▲ ]


## Generate an Application

Run `nx g @storm-software/workspace:app my-app` to generate an application.

> You can use any of the plugins above to generate applications as well.

When using Nx, you can create multiple applications and libraries in the same
workspace.

[ Back to top ▲ ]


## Generate a Library

Run `nx g @storm-software/workspace:lib my-lib` to generate a library.

> You can also use any of the plugins above to generate libraries as well.

Libraries are shareable across libraries and applications. They can be imported
from `@powerlines/my-lib`.

[ Back to top ▲ ]


## Code Scaffolding

Run `nx g @nx/react:component my-component --project=powerlines` to generate a new
component.

[ Back to top ▲ ]


# Testing

Open System uses [Jest](https://jestjs.io/) for unit testing and
[Cypress](https://www.cypress.io/) for end-to-end testing.

[ Back to top ▲ ]


## Running Unit Tests

Run `pnpm test` to execute the unit tests via [Jest](https://jestjs.io).

Run `pnpm affected:test` to execute the unit tests affected by a change.

[ Back to top ▲ ]


## Running End-to-End Tests

Run `pnpm e2e` to execute the end-to-end tests via
[Cypress](https://www.cypress.io).

Run `pnpm affected:e2e` to execute the end-to-end tests affected by a change.

[ Back to top ▲ ]


## Understand your workspace

Run `pnpm graph` to see a diagram of the dependencies of the Open System
projects.

[ Back to top ▲ ]


# ☁ Nx Cloud

Nx caches the output of any previously run command such as testing and building,
so it can replay the cached results instead of rerunning it. Nx Cloud allows you
to share the computation cache across everyone in your team and CI.


Nx Cloud - Dashboard

[ Back to top ▲ ]


# Roadmap

See the [open issues](https://github.com/storm-software/powerlines/issues) for a
list of proposed features (and known issues).

- [Top Feature Requests](https://github.com/storm-software/powerlines/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc)
(Add your votes using the 👍 reaction)
- [Top Bugs](https://github.com/storm-software/powerlines/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc)
(Add your votes using the 👍 reaction)
- [Newest Bugs](https://github.com/storm-software/powerlines/issues?q=is%3Aopen+is%3Aissue+label%3Abug)

[ Back to top ▲ ]


# 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](.github/CODE_OF_CONDUCT.md).

You can use
[markdownlint-cli](https://github.com/storm-software/powerlines/markdownlint-cli) to
check for common markdown style inconsistency.

[ Back to top ▲ ]


# Support

Reach out to the maintainer at one of the following places:

- [Contact](https://stormsoftware.com/contact)
- [GitHub discussions](https://github.com/storm-software/powerlines/discussions)
-

[ Back to top ▲ ]


# License

This project is licensed under the **Apache License 2.0**. Feel free to edit and
distribute this template as you like. If you have any specific questions, please
reach out to the Storm Software development team.

See [LICENSE](LICENSE) for more information.


[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fstorm-software%2Fpowerlines.svg?type=large&issueType=license)](https://app.fossa.io/projects/git%2Bgithub.com%2Fstorm-software%2Fpowerlines?ref=badge_large&issueType=license)

[ Back to top ▲ ]


# Contributors ✨

Thanks goes to these wonderful people
([emoji key](https://allcontributors.org/docs/en/emoji-key)):



Patrick Sullivan
Patrick Sullivan

🎨 💻 🔧 📖 ⚠️
Tyler Benning
Tyler Benning

🎨
Stormie
Stormie

🚧






Add your contributions



This project follows the
[all-contributors](https://github.com/all-contributors/all-contributors)
specification. Contributions of any kind welcome!

[ Back to top ▲ ]







Storm Software




WebsiteContactLinkedInMediumGitHubOpenPGP Key


Fingerprint: F47F 1853 BCAD DE9B 42C8 6316 9FDE EC95 47FE D106


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](https://discord.gg/MQ6YVzakM5) 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](https://stormsoftware.com/contact) or join our
[Slack](https://join.slack.com/t/storm-software/shared_invite/zt-2gsmk04hs-i6yhK_r6urq0dkZYAwq2pA)
channel!


Storm Software



Visit us at stormsoftware.com


[ Back to top ▲ ]