Skip to content

Latest commit

 

History

History
121 lines (68 loc) · 4.24 KB

README-NX.md

File metadata and controls

121 lines (68 loc) · 4.24 KB

Maptio

This is a monorepo generated using Nx.

The app that is currently deployed to production lives under apps/current. It's not strictly a part of the monorepo as it retains it's separate webpack config, package.json, etc. Circle CI test and Heroku deployment work as before, with configuration changed to build from the folder with current code.

Please see apps/current/README.md for details about working on the current codebase

A new app has been scaffolded and resides under apps/maptio. This is a new Angular app (just Angular, no server) that is intended to be the future codebase for Maptio.

The instructions below - scaffolded by Nx CLI - can be used for working on the new app.

Deployment

The new version of the app is hosted on Firebase at https://maptio-preview.web.app (production).

A staging version is hosted at https://maptio-preview-staging.web.app

To deploy changes to staging, simply run nx deploy.

To deploy changes to production, run nx deploy --prod.

Nx

🔎 Nx is a set of Extensible Dev Tools for Monorepos.

Quick Start & Documentation

Nx Documentation

10-minute video showing all Nx features

Interactive Tutorial

Adding capabilities to your workspace

Nx supports many plugins which add capabilities for developing different types of applications and different tools.

These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well.

Below are our core plugins:

  • Angular
    • ng add @nx/angular
  • React
    • ng add @nrwl/react
  • Web (no framework frontends)
    • ng add @nrwl/web
  • Nest
    • ng add @nrwl/nest
  • Express
    • ng add @nx/express
  • Node
    • ng add @nx/node

There are also many community plugins you could add.

Generate an application

Run ng g @nx/angular: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.

Generate a library

Run ng g @nx/angular: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 @maptio/mylib.

Development server

Run ng serve my-app for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run ng g component my-component --project=my-app to generate a new component.

Build

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

Running unit tests

Run ng test my-app to execute the unit tests via Jest.

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

Running end-to-end tests

Run ng e2e my-app to execute the end-to-end tests via Cypress.

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

Understand your workspace

Run nx dep-graph to see a diagram of the dependencies of your projects.

Further help

Visit the Nx Documentation to learn more.

☁ Nx Cloud

Computation Memoization in the Cloud

Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly.

Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers.

Visit Nx Cloud to learn more.