VividTheory

This project was generated using Nx. A live demo is available here

🔎 Smart, Fast and Extensible Build System

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:

• React
  • npm install --save-dev @nrwl/react
• Web (no framework frontends)
  • npm install --save-dev @nrwl/web
• Angular
  • npm install --save-dev @nrwl/angular
• Nest
  • npm install --save-dev @nrwl/nest
• Express
  • npm install --save-dev @nrwl/express
• Node
  • npm install --save-dev @nrwl/node

There are also many community plugins you could add.

Generate an application

Run nx g @nrwl/react: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 nx g @nrwl/react: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 @vivid-theory/mylib.

Environment Variables

The following enviornment variables are required:

key	description	example
DB_HOST	hostname or IP address of database	database.domain.com
DB_PORT	port of database	5432
DB_USER	username of database user	database_user
DB_PASS	password of database user	password
DB_TYPE	type of database	postgres
DB_NAME	name/schema to access	wattage

Development server

• Run npm run dev:smarthomes to bring up both the API and React development server - these will be accessible from http://localhost:3333/ and http://localhost:4200/ respectively
• The main code for the smarthomes application is located in apps/smarthomes-app
• Reusable UI components are locatd in libs/ui-components
  • Alternatively, @vivid-theory/ui for components, and @vivid-theory/ui/functions for reusable functions

To run the API server in isolation

• Run nx serve api to bring up the API server - this will serve on http://localhost:3333/ by default
• The main code for the API is located

Code scaffolding

Run nx g @nrwl/react:component my-component --project=my-app to generate a new component.

Build

Run nx build my-app to build the project. The build artifacts will be stored in the dist/ directory. For a production build, run npm run build:production.

To deploy to heroku, simply commit and push the current branch as-is after configuring environment variables.

Running unit tests

Run nx 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 nx 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 graph to see a diagram of the dependencies of your projects.

Further help

Visit the Nx Documentation to learn more.

☁ Nx Cloud

Distributed Computation Caching & Distributed Task Execution

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.