Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update links in docs #286

Merged
merged 1 commit into from
May 1, 2024
Merged

docs: update links in docs #286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
367 changes: 235 additions & 132 deletions CONTRIBUTING.md
View file
Open in desktop

Large diffs are not rendered by default.

44 changes: 28 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
# Ensono Stacks with Nx

> See [the contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with contributing to the stacks project.
> See [the contributing guide](./CONTRIBUTING.md) for detailed instructions on
> how to get started with contributing to the stacks project.

## Using Stacks

The ideologies of Stacks and [`Nx`](https://nx.dev/) are aligned in their focus on providing businesses with a framework that accelerates development, allowing you to focus on business objectives with best practice code. Leveraging Nx allows us to build upon that work and to fill the gaps with infrastructure, pipelines and the integration with other Stacks subsystems. Leveraging Nx allows a common developer experience, global communities of support, and an enterprise ready base.
The ideologies of Stacks and [`Nx`](https://nx.dev/) are aligned in their focus
on providing businesses with a framework that accelerates development, allowing
you to focus on business objectives with best practice code. Leveraging Nx
allows us to build upon that work and to fill the gaps with infrastructure,
pipelines and the integration with other Stacks subsystems. Leveraging Nx allows
a common developer experience, global communities of support, and an enterprise
ready base.

<!-- markdownlint-disable MD033 -->
<details>
<summary>What is Nx?</summary>
Expand All @@ -13,7 +21,9 @@ The ideologies of Stacks and [`Nx`](https://nx.dev/) are aligned in their focus
<p>Find out more about Nx through their official [documentation](https://nx.dev/getting-started/intro)!</p>
</details>

For the reasons listed above we have chosen to use Nx within Stacks for CSR and SSR frontend web applications, capitalising on Nx generators and executors to streamline your development and testing processes.
For the reasons listed above we have chosen to use Nx within Stacks for CSR and
SSR frontend web applications, capitalising on Nx generators and executors to
streamline your development and testing processes.

<details>
<summary>What are Nx Generators and Executors?</summary>
Expand All @@ -24,19 +34,21 @@ For the reasons listed above we have chosen to use Nx within Stacks for CSR and

## Set up your stacks workspace

Visit the official Stacks documentation site for Nx [here](https://stacks.ensono.com/docs/nx/nx_stacks)!
Visit the official Stacks documentation site for Nx
[here](https://stacks.ensono.com/docs/nx/nx_stacks)!

## Stacks Plugins

To accelerate your project development and ensure consistency across those projects, we have several stacks plugins available!

| Plugin | Description |
| :------------------------------------------------------------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`@ensono-stacks/create-stacks-workspace`](https://stacks.ensono.com/docs/nx/create-stacks-workspace/ensono-stacks-create-stacks-workspace) | Create an Nx workspace using stacks!<li>Create an Nx workspace for a Next application with your choice of testing framework!</li><li>Create a testing project for the generated Next application. Supported: Playwright & Cypress</li> |
| [`@ensono-stacks/workspace`](https://stacks.ensono.com/docs/nx/workspace/ensono-stacks-workspace) | 'Stackify' your existing Nx workspace<li>Add build and deploy infrastructure to your workspace</li><li>Set up libraries to manage code & commit quality</li> |
| [`@ensono-stacks/next`](https://stacks.ensono.com/docs/nx/next/ensono-stacks-next) | Enhance your Next.js project with Stacks!<li>Add stacks configuration and developer tools to an existing next application</li><li>Add NextAuth.js to your next application</li><li>Add build and deploy infrastructure to your next application</li> |
| [`@ensono-stacks/azure-node`](https://stacks.ensono.com/docs/nx/azure-node/ensono-stacks-azure-node) | <li>Add Azure app insights to a node project in your stacks workspace</li> |
| [`@ensono-stacks/rest-client`](https://stacks.ensono.com/docs/nx/rest-client/ensono-stacks-rest-client) | Add a rest client to a project in your stacks workspace<li>Create an Axios http-client with custom configuration</li><li>Create a client endpoint with Axios HTTP methods for your application</li><li>Bump existing endpoints to new versions</li><li>Create code implementation from an OpenApi schema using Orval</li> |
| [`@ensono-stacks/playwright`](https://stacks.ensono.com/docs/nx/playwright/ensono-stacks-playwright) | Add the playwright testing library and much more to your project!<li>Create a playwright testing project for your application</li><li>Add accessibility testing to your test project</li><li>Add native visual testing with playwright</li><li>Add visual testing with Applitools eyes</li><li>Add playwright testing and reporting automatically to your build pipelines</li> |
| [`@ensono-stacks/cypress`](https://stacks.ensono.com/docs/nx/cypress/ensono-stacks-cypress) | Add the cypress testing library and much more to your project!<li>Add accessibility testing to your test project</li><li>Add cypress testing and reporting automatically to your build pipelines</li> |
| [`@ensono-stacks/logger`](https://stacks.ensono.com/docs/nx/logger/ensono-stacks-logger) | Add industry standard logging capabilities to your project<li>Add Winston to your project</li> |
To accelerate your project development and ensure consistency across those
projects, we have several stacks plugins available!

| Plugin | Description |
| :------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`@ensono-stacks/create-stacks-workspace`](https://stacks.ensono.com/docs/getting_started/create-stacks-workspace/ensono-stacks-create-stacks-workspace) | Create an Nx workspace using stacks!<li>Create an Nx workspace for a Next application with your choice of testing framework!</li><li>Create a testing project for the generated Next application. Supported: Playwright & Cypress</li> |
| [`@ensono-stacks/workspace`](https://stacks.ensono.com/docs/getting_started/workspace/ensono-stacks-workspace) | 'Stackify' your existing Nx workspace<li>Add build and deploy infrastructure to your workspace</li><li>Set up libraries to manage code & commit quality</li> |
| [`@ensono-stacks/next`](https://stacks.ensono.com/docs/getting_started/next/ensono-stacks-next) | Enhance your Next.js project with Stacks!<li>Add stacks configuration and developer tools to an existing next application</li><li>Add NextAuth.js to your next application</li><li>Add build and deploy infrastructure to your next application</li> |
| [`@ensono-stacks/azure-node`](https://stacks.ensono.com/docs/getting_started/azure-node/ensono-stacks-azure-node) | <li>Add Azure app insights to a node project in your stacks workspace</li> |
| [`@ensono-stacks/rest-client`](https://stacks.ensono.com/docs/getting_started/rest-client/ensono-stacks-rest-client) | Add a rest client to a project in your stacks workspace<li>Create an Axios http-client with custom configuration</li><li>Create a client endpoint with Axios HTTP methods for your application</li><li>Bump existing endpoints to new versions</li><li>Create code implementation from an OpenApi schema using Orval</li> |
| [`@ensono-stacks/playwright`](https://stacks.ensono.com/docs/getting_started/playwright/ensono-stacks-playwright) | Add the playwright testing library and much more to your project!<li>Create a playwright testing project for your application</li><li>Add accessibility testing to your test project</li><li>Add native visual testing with playwright</li><li>Add visual testing with Applitools eyes</li><li>Add playwright testing and reporting automatically to your build pipelines</li> |
| [`@ensono-stacks/cypress`](https://stacks.ensono.com/docs/getting_started/cypress/ensono-stacks-cypress) | Add the cypress testing library and much more to your project!<li>Add accessibility testing to your test project</li><li>Add cypress testing and reporting automatically to your build pipelines</li> |
| [`@ensono-stacks/logger`](https://stacks.ensono.com/docs/getting_started/logger/ensono-stacks-logger) | Add industry standard logging capabilities to your project<li>Add Winston to your project</li> |
4 changes: 2 additions & 2 deletions packages/azure-node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# @ensono-stacks/azure-node

Please visit the stacks documentation page for `azure-node`
[here](https://stacks.ensono.com/docs/nx/azure-node/ensono-stacks-azure-node) for
more information
[here](https://stacks.ensono.com/docs/getting_started/azure-node/ensono-stacks-azure-node)
for more information

## Generators and Executors

Expand Down
2 changes: 1 addition & 1 deletion packages/create/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# @ensono-stacks/create-stacks-workspace

Please visit the stacks documentation page for `create`
[here](https://stacks.ensono.com/docs/nx/create-stacks-workspace/ensono-stacks-create-stacks-workspace)
[here](https://stacks.ensono.com/docs/getting_started/create-stacks-workspace/ensono-stacks-create-stacks-workspace)
for more information

## Development
Expand Down
4 changes: 2 additions & 2 deletions packages/cypress/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# @ensono-stacks/cypress

Please visit the stacks documentation page for `cypress`
[here](https://stacks.ensono.com/docs/nx/cypress/ensono-stacks-cypress) for more
information
[here](https://stacks.ensono.com/docs/getting_started/cypress/ensono-stacks-cypress)
for more information

## Generators and Executors

Expand Down
4 changes: 2 additions & 2 deletions packages/logger/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# @ensono-stacks/logger

Please visit the stacks documentation page for `logger`
[here](https://stacks.ensono.com/docs/nx/logger/ensono-stacks-logger) for more
information
[here](https://stacks.ensono.com/docs/getting_started/logger/ensono-stacks-logger)
for more information

## Generators and Executors

Expand Down
6 changes: 3 additions & 3 deletions packages/next/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# @ensono-stacks/next

Please visit the stacks documentation page for `next`
[here](https://stacks.ensono.com/docs/nx/next/ensono-stacks-next) for more
information
[here](https://stacks.ensono.com/docs/getting_started/next/ensono-stacks-next)
for more information

## Generators and Executors

Expand Down
4 changes: 2 additions & 2 deletions packages/playwright/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# @ensono-stacks/playwright

Please visit the stacks documentation page for `playwright`
[here](https://stacks.ensono.com/docs/nx/playwright/ensono-stacks-playwright) for
more information
[here](https://stacks.ensono.com/docs/getting_started/playwright/ensono-stacks-playwright)
for more information

## Generators and Executors

Expand Down
2 changes: 1 addition & 1 deletion packages/rest-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# @ensono-stacks/rest-client

Please visit the stacks documentation page for `rest-client`
[here](https://stacks.ensono.com/docs/nx/rest-client/ensono-stacks-rest-client)
[here](https://stacks.ensono.com/docs/getting_started/rest-client/ensono-stacks-rest-client)
for more information

## Generators and Executors
Expand Down
4 changes: 2 additions & 2 deletions packages/workspace/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# @ensono-stacks/workspace

Please visit the stacks documentation page for `workspace`
[here](https://stacks.ensono.com/docs/nx/workspace/ensono-stacks-workspace) for
more information
[here](https://stacks.ensono.com/docs/getting_started/workspace/ensono-stacks-workspace)
for more information

## Generators and Executors

Expand Down
Loading