Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xmlking/ngx-starter-kit

:a: Angular :rocket: NestJS :monkey: Starter Kit
https://github.com/xmlking/ngx-starter-kit

angular jamstack jwt material micro-interactions monorepo nestjs ngxs nx openid postgres scss

Last synced: 7 days ago
JSON representation

:a: Angular :rocket: NestJS :monkey: Starter Kit

Awesome Lists containing this project

README

        

# Ngx Starter Kit

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![Semantic Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![Renovate dependency Status](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
[![Sourcegraph](https://sourcegraph.com/github.com/xmlking/ngx-starter-kit/-/badge.svg)](https://sourcegraph.com/github.com/xmlking/ngx-starter-kit?badge)

### Quality

[![CodeQL](https://github.com/xmlking/ngx-starter-kit/workflows/CodeQL/badge.svg?event=push)](https://github.com/xmlking/ngx-starter-kit/actions?query=workflow%3ACodeQL)
[![Codecov](https://codecov.io/gh/xmlking/ngx-starter-kit/branch/develop/graph/badge.svg)](https://codecov.io/gh/xmlking/ngx-starter-kit)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/xmlking/ngx-starter-kit.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/xmlking/ngx-starter-kit/alerts/)
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/xmlking/ngx-starter-kit.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/xmlking/ngx-starter-kit/context:javascript)

### Build Status

[![Build Status](https://github.com/xmlking/ngx-starter-kit/workflows/Test%20on%20Push%20for%20WebApp/badge.svg?branch=develop)](https://github.com/xmlking/ngx-starter-kit/actions?query=workflow%3A%22Test+on+Push+for+WebApp%22)
[![Build Status](https://github.com/xmlking/ngx-starter-kit/workflows/Test%20on%20Push%20for%20API/badge.svg?branch=develop)](https://github.com/xmlking/ngx-starter-kit/actions?query=workflow%3A%22Test+on+Push+for+API%22)

This project was generated using [Nx](https://nx.dev).

🔎 **Nx is a set of Angular CLI power-ups for modern development.**

Live [Demo](https://xmlking.github.io/ngx-starter-kit/index.html)

Docs on [GitBook](https://xmlking.gitbook.io/ngx-starter-kit/v/develop/)

If you are interested in smaller example project: [Mini-starter-kit](https://github.com/xmlking/connect4)

**PANTS** (:elephant: _PostgreSQL_ :a: _Angular_ :rocket: _NestJS_ :snowman: _TypeScript_) Stack in :dolphin: NX workspace

## Install

```bash
git clone https://github.com/xmlking/ngx-starter-kit.git my-project
cd my-project
npm install --force
```

## Development server

Run `npm run start` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.

Run `npm run start:mock` for a mock server.

Run `npm run start -- --proxy-config proxy.conf.js` to start with proxy

## Build

Run `npm run build:prod` to build the project. The build artifacts will be stored in the `dist/` directory.

## Running unit tests

Run `npm run test ` to execute the unit tests via [Jest](https://jestjs.io/).

## Running end-to-end tests

Run `npm run e2e` to execute the end-to-end tests via [Cypress](https://www.cypress.io/).

## Docs

Run `npm run doc:build` to build docs.
Run `npm run doc:serve` to serve docs.

## Deploy

Run `npm run deploy:mock` to deploy demo app to gp-pages.

Analyzing bundle size `ng run webapp:analyze`

Analyzing and Visualizing the Dependency Graph (affected modules by uncommitted changes)

`nx affected:dep-graph`