0.0.1-alpha.4 • Published 2 years ago

@20i/nx v0.0.1-alpha.4

Weekly downloads
-
License
-
Repository
-
Last release
2 years ago

@20i/nx

This library was generated with Nx.

How to use

Disclaimer: The 20i nx project is still young and experimental. These docs will be updated to reflect its use as we continue development.

Prerequisites

You must be running Nx on at least version 14 in order for this to work. You can install the Nx cli globally to run it as nx or you can use npx nx, yarn nx etc.

# Check your Nx cli version
npx nx --version
# 14.5.1 is a confirmed version that works with the 20i Nx generators

Starting a new workspace

To start a new Nx workspace using the 20i preset, use the --preset flag with create-nx-workspace. This will initialize a new repository for you.

npx create-nx-workspace --preset=@20i/nx --packageManager yarn

Adding apps to your workspace

You can use any of the default Nx generators or the @20i/nx generators to add apps to your workspace.

# Run an Nx generator from a plugin package. 
npx nx g <plugin>:<generator> <directory>

# If this was an app generator, it will add files to apps/<directory>
# If it was a library generator, it goes into libs/<directory>

Nest API

yarn add -D @nrwl/nest
npx nx g @20i/nx:nest server/api

React app

yarn add -D @nrwl/react
npx nx g @20i/nx:react web/app

Nest Console app

yarn add -D @nrwl/nest
npx nx g @20i/nx:console console

Prisma library for Nest

yarn add -D @nrwl/js
npx nx g @20i/nx:prisma db

Core Nx plugins

The @20i/nx generators are great to get you started with Nx since they will configure your application to match Twenty Ideas standards. There is also a set of core Nx plugins.

Example: npx nx g @nrwl/react:lib my-lib to generate an application.

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

Below are the core Nx plugins:

  • @nrwl/react
  • @nrwl/web
  • @nrwl/angular
  • @nrwl/nest
  • @nrwl/express
  • @nrwl/node

There are also many community plugins you could add.