- Write documentation in English.
- Keep generated code in English (identifiers, comments, and user-facing text).
✨ Your new, shiny Nx workspace is almost ready ✨.
Learn more about this workspace setup and its capabilities or run npx nx graph to visually explore what was created. Now, let's get you up to speed!
Click here to finish setting up your workspace!
npx nx g @nx/js:lib libs/pkg1 --publishable --importPath=@my-org/pkg1 --no-tuinpx nx g @nx/react:app apps/my-app --bundler=vite --no-tuiTo build the library use:
npx nx build pkg1To run any task with Nx use:
npx nx <target> <project-name>These targets are either inferred automatically or defined in the project.json or package.json files.
Use one command for local SSR development over HTTPS:
npm run dev:ssrDuring dependency installation, the workspace creates .cert/localhost-key.pem and .cert/localhost-cert.pem if they do not exist.
Certificates are prepared during npm install using the npm mkcert-cli package and local CA registration.
Certificate setup is skipped for production installs (NODE_ENV=production or npm install --omit=dev).
If you need to recreate certificates manually:
npm run setup:certsBuild production SSR artifacts (web client + web server bundle + API server):
npm run build:ssrStart the production SSR server after building:
npm run start:ssrQuick checks after startup:
https://localhost:3000/returns HTML rendered by SSR.https://localhost:3000/apireturns JSON from Fastify API.
More about running tasks in the docs »
To version and release the library use
npx nx release
Pass --dry-run to see what would happen without actually releasing the library.
Nx automatically updates TypeScript project references in tsconfig.json files to ensure they remain accurate based on your project dependencies (import or require statements). This sync is automatically done when running tasks such as build or typecheck, which require updated references to function correctly.
To manually trigger the process to sync the project graph dependencies information to the TypeScript project references, run the following command:
npx nx syncYou can enforce that the TypeScript project references are always in the correct state when running in CI by adding a step to your CI job configuration that runs the following command:
npx nx sync:checkNx Console is an editor extension that enriches your developer experience. It lets you run tasks, generate code, and improves code autocompletion in your IDE. It is available for VSCode and IntelliJ.
Learn more:
- Learn more about this workspace setup
- Learn about Nx on CI
- Releasing Packages with Nx release
- What are Nx plugins?
And join the Nx community: