humainflow-web/README.md

88 lines
2.4 KiB
Markdown

# HumAInFlow
This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 21.0.3.
## Development server
To start a local development server, run:
```bash
ng serve
```
Once the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files.
## Code scaffolding
Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
```bash
ng generate component component-name
```
For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
```bash
ng generate --help
```
## Building
To build the project run:
```bash
ng build
```
This will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed.
## Running unit tests
To execute unit tests with the [Vitest](https://vitest.dev/) test runner, use the following command:
```bash
ng test
```
## Running end-to-end tests
For end-to-end (e2e) testing, run:
```bash
ng e2e
```
Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
## Additional Resources
For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
## BUILD DOCKER IMAGE
docker buildx build --platform linux/amd64,linux/arm64 -t luciolelii/humainflow-gui:latest . --push
## License
Copyright (C) 2025-2026 Lucio Lelii — ISTI-CNR.
HumAIn Flow is released under the **GNU Affero General Public License v3.0 or
later** ([LICENSE](LICENSE)), with an **additional attribution term under
section 7(b)** of that license ([LICENSE-ADDENDUM](LICENSE-ADDENDUM)).
In practice this means:
- you may use, study, modify and redistribute it freely;
- if you run a modified version as a network service, you must offer its
source to the users of that service;
- any work based on it must keep the attribution below, both in the source
and where the interface shows its legal notices:
> Based on HumAIn Flow, originally developed by Lucio Lelii (ISTI-CNR)
> — https://github.com/luciolelii/humanaiFlow-angular
If you use HumAIn Flow in academic work, please cite it — see
[CITATION.cff](CITATION.cff).