@rucken/core-nestjs
v1.0.12
Published
Basic entities, services and controllers for NestJS REST backend
Downloads
142
Maintainers
Readme
Basic entities, services and controllers for NestJS REST backend
Features
- NestJS - a JS backend framework providing architecture out of the box with a syntax similar to Angular
- TypeORM - ORM for TypeScript and JavaScript (ES7, ES6, ES5). Supports MySQL, PostgreSQL, MariaDB, SQLite, MS SQL Server, Oracle, WebSQL databases.
- TypeScript - superset of JS which compiles to JS, providing compile-time type checking
- Passport - a popular library used to implement JavaScript authentication (Facebook, Google+)
- jsonwebtoken - a JavaScript json web tokens implementation by auth0
- @nrwl/schematics - Angular CLI power-ups for modern development, example usage:
ng g @nrwl/schematics:node-app app-name --framework nestjs
- @nestjs/schematics - Nest architecture element generation based on Angular schematics, example usage:
ng g @nestjs/schematics:library lib-name
Usage
- clone or fork repository
git clone --recursive https://github.com/rucken/core-nestjs.git
- make sure you have node.js installed version 11+
- copy
develop._env
todevelop.env
and set environments for use (on Windows copy with IDE) - run
npm install
to install project dependencies - run
npm run build
to install project dependencies - run
npm run start:prod
to fire up prod server (npm run start:dev
- dev server) - Open browser to
http://localhost:5000/swagger
Demo
https://core-nestjs.rucken.io - Application with Sqlite Database on VPS with Dokku
Users
- user with admin group: [email protected], password: 12345678
- user with user group: [email protected], password: 12345678
- user with user group: [email protected], password: 12345678
Swagger
- local:
http://localhost:5000/swagger
- online:
https://core-nestjs.rucken.io/swagger
- apiKey template:
JWT <token_generated_on_login>
Typedoc documentations
- local:
http://localhost:5000/docs
- online:
https://core-nestjs.rucken.io/docs
Quick links
Frontend (with core)
@rucken/core - Core with Admin UI for web application maked on Angular7+ and Bootstrap3.
@rucken/todo - Core with UI for web todo application maked on Angular7+ and Bootstrap3.
Backend
@rucken/core-nestjs - A simple application demonstrating the basic usage of permissions with NestJS (JWT, Passport, Facebook, Google+, User, Group, Permission).
@rucken/todo-nestjs - A simple todo application with NestJS (Projects, Tasks, Statuses).
Mobile
@rucken/ionic - Admin UI for Ionic4 with Angular7+ mobile application.
@rucken/todo-ionic - Admin UI for Ionic4 with Angular7+ mobile todo application
Console
@rucken/cli - Console tools to create and build Angular7+ and NestJS application based on Rucken template
License
MIT