NNA

This is a rework of https://github.com/HugoMendes98/Nx-NestJS-Angular.

This is still in progress.

Code	Code coverage	Comment coverage
apps/backend
apps/frontend
apps/office
libs/common
libs/front
packages/angular
packages/core
packages/nest

Table of contents

• Description
• Requirements
  • DevContainer
• Quick Start-up
  • Install
  • Run the backend
  • Run the frontend
  • Run the office
• Contribution / development

Description

!! Description of your project !!

Requirements

If you use (or want to use/try) DevContainer, you can directly go here.

To develop this project, the following conditions are expected:

• NodeJS (>= 20) - Build/run applications
  • The "real" version for the applications is in the nvmrc file, so nvm can be used: nvm use
• npm - Install dependencies and main executor for the "officials" commands of the project.
• docker - To build docker images and for development-server dependencies.

---

Development-server dependencies (database, mail server, ...) can be served with:

docker compose up 

DevContainer

DevContainer allows to develop in a IDE inside a docker with all above requirements satisfied.
It also gives to all developers an (almost) identical environment.

• IntelliJ IDEA
• VS Code - Summary:
  1. Install the Dev Containers extension
  2. Open the project as a DevContainer

Note:
With VS Code, it also installs some extensions and configuration such as:

• Auto-format (eslint)
• Access to the development Database
• ...

Quick Start-up

Some commands to quickly run the applications:

Go here for more commands and related information.

Install

Install the node packages:

npm install

Run the backend

Creates the database and seed with a basic set of data:

npx mikro-orm migration:fresh --seed SimpleSeeder

And run the backend application:

npm run backend:start

Run the frontend

npm run frontend:start

Run the office

npm run office:start

Contribution / development

The following are guides/instructions to contribute to the project:

• Git flow - How to submit changes to the project
• Development "guide" - How one should develop in this project