nx-ng-starter

(β˜… 135)

Monorepo starter with workflow automation: Nx, Angular, Angular Elements, Electron, NodeJS, NestJS, Firebase.

  • .dockerignore
  • .editorconfig
  • .eslintrc.module-boundaries.mjs
  • .eslintrc.naming-convention.mjs
  • .gitignore
  • .ncurc.json
  • .nxignore
  • .prettierignore
  • .prettierrc
  • .stylelintrc
  • .yarnrc.yml
  • babel.config.json
  • capacitor.config.json
  • CODE_OF_CONDUCT.md
  • commitlint.config.js
  • commitlint.plugin.js
  • CONTRIBUTING.md
  • eslint.config.mjs
  • LICENSE
  • nx.json
  • package.json
  • README.md
  • SECURITY.md
  • SUPPORT.md
  • tsconfig.base.json
  • tsconfig.compodoc.json
  • UNIT_COVERAGE.md
  • vitest.config.ts
  • vitest.shared.ts
  • yarn.lock

# Installation Guide

1. Get the code
git clone https://github.com/rfprod/nx-ng-starter

Downloads the entire project code from GitHub to your computer.

cd nx-ng-starter

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Scoop A package manager for Windows.
scoop install shellcheck

Installs directly via Scoop (Windows).

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
cd android/app

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

βœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
yarn install --frozen-lockfile

Downloads and installs the libraries listed in package.json.

yarn start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation