Skip to content

Commit

Permalink
docs(repo): Add notice that repo has been moved to ReadMe file
Browse files Browse the repository at this point in the history
  • Loading branch information
sullivanpj committed Nov 3, 2023
1 parent 3fe50e7 commit 387fc58
Showing 1 changed file with 54 additions and 54 deletions.
108 changes: 54 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The <b>Open System</b> is a monorepo containing modern, scalable web application

[![github](https://img.shields.io/github/package-json/v/sullivanpj/open-system?style=for-the-badge&color=10B981)](https://github.com/sullivanpj/open-system)&nbsp;[![Nx](https://img.shields.io/badge/Nx-14.4.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=10B981)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-13.0.5-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=10B981)](https://nextjs.org/)&nbsp;[![codecov.io](https://img.shields.io/codecov/c/github/commitizen/cz-cli.svg?style=for-the-badge&color=10B981)](https://codecov.io/github/commitizen/cz-cli?branch=master)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=10B981)](http://commitizen.github.io/cz-cli/)&nbsp;![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=10B981)&nbsp;[![documented with docusaurus](https://img.shields.io/badge/documented_with-docusaurus-success.svg?style=for-the-badge&logo=readthedocs&color=10B981)](https://docusaurus.io/)

<h3 align="center" bold="true">⚠️ <b>Attention</b> ⚠️ - 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.<br /><br /></h3>
<h3 align="center" bold="true">⚠️ <b>Attention</b> ⚠️ - This repository has been moved over to the <a href="https://github.com/storm-software" target="_blank">⚡Storm Software organization</a> to allow for easier collaboration with other OSS developers! Please see: <a href="https://github.com/storm-software/storm-ops" target="_blank">Storm-Ops repository - Workspace Tools</a>, <a href="https://github.com/storm-software/forecast" target="_blank">Forecast repository - CodeGen Tools</a>, and <a href="https://github.com/storm-software/stormstack" target="_blank">Storm-Stack repository - General Web Application Libraries</a>. <br /><br /></h3>

<!--#if GitHubActions-->

Expand All @@ -24,28 +24,28 @@ The <b>Open System</b> is a monorepo containing modern, scalable web application

## Table of Contents

- [Quick Features](#quick-features)
- [Tech Stack](#tech-stack)
- [Getting Started](#getting-started)
- [Build](#build)
- [Development Server](#development-server)
- [Storm - Model-Driven Development](#storm---model-driven-development)
- [Environment Configuration Help](#environment-configuration-help)
- [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)
- [Distributed Computation Caching \& Distributed Task Execution](#distributed-computation-caching--distributed-task-execution)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [Support](#support)
- [License](#license)
- [Contributors ✨](#contributors-)
- [Quick Features](#quick-features)
- [Tech Stack](#tech-stack)
- [Getting Started](#getting-started)
- [Build](#build)
- [Development Server](#development-server)
- [Storm - Model-Driven Development](#storm---model-driven-development)
- [Environment Configuration Help](#environment-configuration-help)
- [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)
- [Distributed Computation Caching \& Distributed Task Execution](#distributed-computation-caching--distributed-task-execution)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [Support](#support)
- [License](#license)
- [Contributors ✨](#contributors-)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand All @@ -55,16 +55,16 @@ The <b>Open System</b> is a monorepo containing modern, scalable web application

The following are some of the features/publishable code that are included in this repository:

- Transport/protocol/backend agnostic data fetching (REST, GraphQL, promises, whatever!)
- Auto Caching + Refetching (stale-while-revalidate, Window Refocus, Polling/Realtime)
- Parallel + Dependent Queries
- Mutations + Reactive Query Refetching
- Multi-layer Cache + Automatic Garbage Collection
- Paginated + Cursor-based Queries
- Load-More + Infinite Scroll Queries w/ Scroll Recovery
- Request Cancellation
- React Suspense + Fetch-As-You-Render Query Prefetching
- Dedicated Devtools
- Transport/protocol/backend agnostic data fetching (REST, GraphQL, promises, whatever!)
- Auto Caching + Refetching (stale-while-revalidate, Window Refocus, Polling/Realtime)
- Parallel + Dependent Queries
- Mutations + Reactive Query Refetching
- Multi-layer Cache + Automatic Garbage Collection
- Paginated + Cursor-based Queries
- Load-More + Infinite Scroll Queries w/ Scroll Recovery
- Request Cancellation
- React Suspense + Fetch-As-You-Render Query Prefetching
- Dedicated Devtools

## Tech Stack

Expand Down Expand Up @@ -108,16 +108,16 @@ If you run into any issues while trying to run any of the above steps, please re

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...
- [@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...

## Generate an Application

Expand Down Expand Up @@ -180,21 +180,21 @@ Visit [Nx Cloud](https://nx.app/) to learn more.

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

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

# 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.
- _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).

Expand All @@ -205,9 +205,9 @@ You can use [markdownlint-cli](https://github.com/sullivanpj/open-system/markdow

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

- [Contact](https://www.patsullivan.org/contact)
- [GitHub discussions](https://github.com/sullivanpj/open-system/discussions)
- <contact@patsullivan.org>
- [Contact](https://www.patsullivan.org/contact)
- [GitHub discussions](https://github.com/sullivanpj/open-system/discussions)
- <contact@patsullivan.org>

# License

Expand Down

0 comments on commit 387fc58

Please sign in to comment.