Skip to content

Latest commit

 

History

History
102 lines (61 loc) · 7.51 KB

GETTING_STARTED.md

File metadata and controls

102 lines (61 loc) · 7.51 KB
Raw

Create an application

Description Command
Create a frontend application with Next. 📘 npm run create.app.next
Create a frontend application with React. 📘. npm run create.app.react
Create a mobile application with React-Native. 📘 npm run create.app.react-native
Create a desktop application with Electron. 📘 npm run create.app.electron
Create server-side application with Nest. 📘 npm run create.app.nest

Create a library

Description Command
Create a JavaScript library using Typescript. 📘 npm run create.lib.ts <libname> -- --buildable --publishable --importPath @enio.ai/<libname>
Create a UI component library with React. 📘 npm run create.lib.react
Create a mobile component library with React-Native. 📘 npm run create.lib.react-native
Create server-side library with Nest. 📘 npm run create.lib.nest
Create a UI component library with Next. 📘 npm run create.lib.next

You should specify the following flags --buildable and/or --publishable when building new libraries. 📘.

Libraries are shareable across libraries and applications. They can be imported from @enio/mylib.

Setup documentation automation

Run npm run create.docs followed by the name of your project. This will automatically collect details of your project to produce technical documentation. See documentation.

Setup a delovepment environment

Storybook is a development environment for UI components. It allows you to browse a component library, view the different states of each component, and interactively develop and test components. Run npm run create.book followed by the name of your project. See documentation.

Run npm run serve.book to build the environment to showcase the UI components in memory and serve it to a particular port for local development.

Run npm run build.book to built a static site to demo and possibly deploy publicly to showcase the UI components in the frontend library.

Development server

Run npm run serve followed by the name of your application for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Generators are typically command line tools that runs some scripts to generate boilerplate code.

Take for example React generators. You can run nx g @nrwl/react:component my-component --project=my-app to generate a new component.

See full generators directory.

Running unit tests

Run npm run test followed by the name of the project to run unit tests for it. Execute the unit tests via Jest.

Run npm run test:affected to execute the unit tests affected by a change.

Running end-to-end tests

Run npm run e2e followed by the name of the project to execute the end-to-end tests via Cypress.

Run npm run e2e:affected to execute the end-to-end tests affected by a change.

Build

Run npm run build followed by the name of the project to build it. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Deploy

Apps and libraries contained here that are meant to be available outside this repository would go through a deploymentment step of sorts. A frontend app might be deployed to a static hosting service, a backend application to some cloud servers, and some libraries published to a registry or CDN.

Here are a few commands that are available to publish applications.

Description Command
Configure a project to be deployable using Firebase Hosting npm run setup.firebase.hosting
Configure one or more projects with Firebase at once npm run setup.firebase
Deploy an app with Firebase nx run {my-app}:firebase --cmd deploy

Learn more about firebase and nx integration 📘

For libraries that are to be distributed externally, you can publish as npm module via npm run publish.

Understand your workspace

Run npm run graph to see a diagram of the dependencies of your projects.

Further help

Visit the Nx Documentation to learn more.