https://github.com/heap-code/nna
https://github.com/heap-code/nna
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/heap-code/nna
- Owner: heap-code
- License: mit
- Created: 2023-12-15T17:46:43.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2026-02-10T14:57:31.000Z (5 months ago)
- Last Synced: 2026-02-10T19:02:30.885Z (5 months ago)
- Language: TypeScript
- Size: 5.77 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NNA
> This is a rework of .
>
> 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](#description)
- [Requirements](#requirements)
- [DevContainer](#devcontainer)
- [Quick Start-up](#quick-start-up)
- [Install](#install)
- [Run the `backend`](#run-the-backend)
- [Run the `frontend`](#run-the-frontend)
- [Run the `office`](#run-the-office)
- [Contribution / development](#contribution--development)
## Description
!! Description of your project !!
## Requirements
> If you use (or want to use/try) `DevContainer`, you can directly go [here](#devcontainer).
To develop this project, the following conditions are expected:
- [NodeJS](https://nodejs.org/en) (>= 20) - Build/run applications
- The "real" version for the applications is in the [nvmrc file](./.nvmrc), so [nvm](https://github.com/nvm-sh/nvm) can be used: `nvm use`
- [npm](https://www.npmjs.com/) - Install dependencies and main executor for the "officials" commands of the project.
- [docker](https://www.docker.com/) - To build docker images and for _development-server_ dependencies.
---
_Development-server_ dependencies (database, mail server, ...) can be served with:
```bash
docker compose up
```
### DevContainer
[DevContainer](https://containers.dev/) 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](https://www.jetbrains.com/help/idea/connect-to-devcontainer.html)
- [VS Code](https://code.visualstudio.com/docs/devcontainers/containers) - Summary:
1. Install the [Dev Containers extension](vscode:extension/ms-vscode-remote.remote-containers)
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](./docs/commands.md) for more commands and related information.
### Install
Install the node packages:
```bash
npm install
```
### Run the `backend`
Creates the database and seed with a basic set of data:
```bash
npx mikro-orm migration:fresh --seed SimpleSeeder
```
And run the `backend` application:
```bash
npm run backend:start
```
### Run the `frontend`
```bash
npm run frontend:start
```
### Run the `office`
```bash
npm run office:start
```
## Contribution / development
The following are guides/instructions to contribute to the project:
- [Git flow](./docs/flow.git.md) - How to submit changes to the project
- [Development "guide"](./docs/flow.dev.md) - How one should develop in this project