Nest.js single page application using common libraries.

Description

This example project demonstrates how easy it is to set up a RESTful single page application, complete with entity/service/repository layers and more. The backend folder is where all the magic happens using common libraries. The frontend is simply generated with @angular/cli, no tweaks are applied there. It should also be mentioned that angular can easily be swapped to any other framework, as long as it exposes an index.html file.

Libraries

This project makes use of the following libraries to do the heavy lifting.

• moesjarraf/nestjs-common Nest.js common libraries
• moesjarraf/nestjs-library Nest.js 3rd party libraries

Running the project

Backend

$ cd backend
$ npm install
$ npm run start:dev
# backend is now running on localhost:3000

Frontend

$ cd frontend
$ npm install
$ npm run start
# frontend is now running on localhost:4200

Endpoints

You can play around with all the endpoints through the swagger API, found at localhost:3000/api. Note that the /api path prefix is reserved for the backend, all other endpoints that do not start with that prefix are assumed to be frontend single page app paths.

Root (/)

The following behavior is applied to the root endpoint by default.

• localhost:3000 OR localhost:3000/api - swagger documentation

When the FRONTEND_INDEX env variable is set, and is correctly pointing to an index.html file, the backend will serve the frontend as a single page application. To get this behavior in this example project, all you have to do is cd frontend && npm run build, so that the index.html file is created.

• localhost:3000 - serves frontend
• localhost:3000/api - swagger documentation

Cats (/api/cats)

The cats endpoint contains CRUD functionality that is easily added by extending a crud controller.

Users (/api/users)

The user endpoint demonstrates an integration with keycloak, and how to protect a resource using nest-keycloak-connect.

Keycloak (/api/keycloak)

The keycloak endpoint allows you to easily login to a keycloak server, and retrieve user information.

Configuration

For all the default configuration options that can be applied to the backend, see this link.

Contributing

Commit messages should be formatted according to semantic-release standards, see this link for more information. A tool has been added to the project to make adhering to the standards easier.

# add source files
git add .

# format commit message
npm run commit

# push
git push -u origin master