aurea-eden 1.25.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.gitattributes +2 -0
- package/.github/workflows/static.yml +43 -0
- package/CHANGELOG.md +60 -0
- package/LICENSE +17 -0
- package/README.md +171 -0
- package/README_.md +174 -0
- package/assets/3diagram_logo.png +0 -0
- package/assets/aurea-eden-logo.jpeg +0 -0
- package/assets/favicon/about.txt +6 -0
- package/assets/favicon/android-chrome-192x192.png +0 -0
- package/assets/favicon/android-chrome-512x512.png +0 -0
- package/assets/favicon/apple-touch-icon.png +0 -0
- package/assets/favicon/favicon-16x16.png +0 -0
- package/assets/favicon/favicon-32x32.png +0 -0
- package/assets/favicon/favicon.ico +0 -0
- package/assets/favicon/site.webmanifest +1 -0
- package/assets/threejs_camera.jpg.webp +0 -0
- package/assets/threejs_camera3.jpg.webp +0 -0
- package/assets/threejs_cameras.webp +0 -0
- package/assets/threejs_cameras2.webp +0 -0
- package/assets/threejs_objects.webp +0 -0
- package/assets/threejs_scene.webp +0 -0
- package/assets/threejs_scene_graph.webp +0 -0
- package/dist/bpmn-diagram.es.js +33126 -0
- package/dist/bpmn-diagram.umd.js +5790 -0
- package/favicon.ico +0 -0
- package/index.html +34 -0
- package/index.js +153 -0
- package/lib/connectors/Connector.js +47 -0
- package/lib/diagrams/Diagram.js +710 -0
- package/lib/diagrams/DiagramConstants.js +22 -0
- package/lib/elements/Element.js +860 -0
- package/lib/materials/BarMaterial.js +17 -0
- package/lib/materials/DiagramEditMaterial.js +28 -0
- package/lib/notations/BpmnDiagram.js +861 -0
- package/lib/shapes/Shape.js +23 -0
- package/lib/shapes/bar/ValueBarConstants.js +34 -0
- package/lib/shapes/bar/ValueBarShape.js +52 -0
- package/lib/shapes/basic/BasicShapeConstants.js +23 -0
- package/lib/shapes/basic/BoxShape.js +12 -0
- package/lib/shapes/basic/CircleShape.js +55 -0
- package/lib/shapes/basic/DiamondShape.js +169 -0
- package/lib/shapes/basic/RoundedRectangleShape.js +180 -0
- package/lib/shapes/connector/ConnectorConstants.js +7 -0
- package/lib/shapes/connector/RoundedCornerOrthogonalConnectorShape.js +229 -0
- package/lib/shapes/icon/IconConstants.js +7 -0
- package/lib/shapes/icon/IconShape.js +92 -0
- package/lib/shapes/icon/bpmn/activities/ad-hoc-marker.svg +50 -0
- package/lib/shapes/icon/bpmn/activities/business-rule.svg +92 -0
- package/lib/shapes/icon/bpmn/activities/compensation-marker.svg +50 -0
- package/lib/shapes/icon/bpmn/activities/loop-marker.svg +50 -0
- package/lib/shapes/icon/bpmn/activities/manual.svg +51 -0
- package/lib/shapes/icon/bpmn/activities/parallel-mi-marker.svg +70 -0
- package/lib/shapes/icon/bpmn/activities/receive.svg +77 -0
- package/lib/shapes/icon/bpmn/activities/script.svg +54 -0
- package/lib/shapes/icon/bpmn/activities/send.svg +86 -0
- package/lib/shapes/icon/bpmn/activities/sequential-mi-marker.svg +70 -0
- package/lib/shapes/icon/bpmn/activities/service.svg +58 -0
- package/lib/shapes/icon/bpmn/activities/sub-process-marker.svg +51 -0
- package/lib/shapes/icon/bpmn/activities/user.svg +50 -0
- package/lib/shapes/icon/bpmn/events/compensation.svg +47 -0
- package/lib/shapes/icon/bpmn/events/conditional.svg +47 -0
- package/lib/shapes/icon/bpmn/events/error.svg +47 -0
- package/lib/shapes/icon/bpmn/events/escalation.svg +47 -0
- package/lib/shapes/icon/bpmn/events/intermediate-compensation.svg +53 -0
- package/lib/shapes/icon/bpmn/events/intermediate-conditional.svg +53 -0
- package/lib/shapes/icon/bpmn/events/intermediate-escalation.svg +53 -0
- package/lib/shapes/icon/bpmn/events/intermediate-link-catch.svg +53 -0
- package/lib/shapes/icon/bpmn/events/intermediate-link-throw.svg +53 -0
- package/lib/shapes/icon/bpmn/events/intermediate-receive.svg +53 -0
- package/lib/shapes/icon/bpmn/events/intermediate-send.svg +69 -0
- package/lib/shapes/icon/bpmn/events/intermediate-signal-catch.svg +53 -0
- package/lib/shapes/icon/bpmn/events/intermediate-signal-throw.svg +53 -0
- package/lib/shapes/icon/bpmn/events/intermediate-timer.svg +107 -0
- package/lib/shapes/icon/bpmn/events/intermediate.svg +49 -0
- package/lib/shapes/icon/bpmn/events/message-end.svg +54 -0
- package/lib/shapes/icon/bpmn/events/message-start.svg +41 -0
- package/lib/shapes/icon/bpmn/events/signal-end.svg +47 -0
- package/lib/shapes/icon/bpmn/events/signal-start.svg +47 -0
- package/lib/shapes/icon/bpmn/events/terminate.svg +49 -0
- package/lib/shapes/icon/bpmn/events/timer.svg +104 -0
- package/lib/shapes/icon/bpmn/gateways/complex.svg +61 -0
- package/lib/shapes/icon/bpmn/gateways/event-based.svg +68 -0
- package/lib/shapes/icon/bpmn/gateways/exclusive.svg +57 -0
- package/lib/shapes/icon/bpmn/gateways/inclusive.svg +57 -0
- package/lib/shapes/icon/bpmn/gateways/parallel.svg +56 -0
- package/lib/shapes/icon/decorators.svg +262 -0
- package/lib/shapes/icon/hexagon.svg +5 -0
- package/lib/shapes/text/Roboto_Regular.json +5610 -0
- package/lib/shapes/text/TextShape.js +29 -0
- package/lib/shapes/text/fonts/Roboto.zip +0 -0
- package/package.json +45 -0
- package/vite.config.js +15 -0
package/.gitattributes
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Simple workflow for deploying static content to GitHub Pages
|
|
2
|
+
name: Deploy static content to Pages
|
|
3
|
+
|
|
4
|
+
on:
|
|
5
|
+
# Runs on pushes targeting the default branch
|
|
6
|
+
push:
|
|
7
|
+
branches: ["main"]
|
|
8
|
+
|
|
9
|
+
# Allows you to run this workflow manually from the Actions tab
|
|
10
|
+
workflow_dispatch:
|
|
11
|
+
|
|
12
|
+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
|
13
|
+
permissions:
|
|
14
|
+
contents: read
|
|
15
|
+
pages: write
|
|
16
|
+
id-token: write
|
|
17
|
+
|
|
18
|
+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
|
|
19
|
+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
|
|
20
|
+
concurrency:
|
|
21
|
+
group: "pages"
|
|
22
|
+
cancel-in-progress: false
|
|
23
|
+
|
|
24
|
+
jobs:
|
|
25
|
+
# Single deploy job since we're just deploying
|
|
26
|
+
deploy:
|
|
27
|
+
environment:
|
|
28
|
+
name: github-pages
|
|
29
|
+
url: ${{ steps.deployment.outputs.page_url }}
|
|
30
|
+
runs-on: ubuntu-latest
|
|
31
|
+
steps:
|
|
32
|
+
- name: Checkout
|
|
33
|
+
uses: actions/checkout@v4
|
|
34
|
+
- name: Setup Pages
|
|
35
|
+
uses: actions/configure-pages@v5
|
|
36
|
+
- name: Upload artifact
|
|
37
|
+
uses: actions/upload-pages-artifact@v3
|
|
38
|
+
with:
|
|
39
|
+
# Upload entire repository
|
|
40
|
+
path: '.'
|
|
41
|
+
- name: Deploy to GitHub Pages
|
|
42
|
+
id: deployment
|
|
43
|
+
uses: actions/deploy-pages@v4
|
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
|
4
|
+
|
|
5
|
+
### [1.25.1](https://gitlab.tecna.pl/waszkowski_r/three-diagram/compare/v1.25.0...v1.25.1) (2025-04-30)
|
|
6
|
+
|
|
7
|
+
## [1.25.0](https://gitlab.tecna.pl/waszkowski_r/three-diagram/compare/v1.24.0...v1.25.0) (2025-04-30)
|
|
8
|
+
|
|
9
|
+
## [1.24.0] - 2025-04-30
|
|
10
|
+
### Added
|
|
11
|
+
- Complete JSDoc documentation for main module and components
|
|
12
|
+
|
|
13
|
+
## [1.1.0] - 2025-04-26
|
|
14
|
+
### Added
|
|
15
|
+
- New sample diagrams for demonstration
|
|
16
|
+
- Spot light functionality for better 3D visualization
|
|
17
|
+
### Changed
|
|
18
|
+
- Enhanced diagram display modes
|
|
19
|
+
|
|
20
|
+
## [1.0.0] - 2025-03-16
|
|
21
|
+
### Added
|
|
22
|
+
- Complete BPMN notation support
|
|
23
|
+
- BPMN elements and icons
|
|
24
|
+
- Icon placeholders system
|
|
25
|
+
- Text wrapping functionality
|
|
26
|
+
### Changed
|
|
27
|
+
- Improved icon shape handling
|
|
28
|
+
|
|
29
|
+
## [0.3.0] - 2025-02-28
|
|
30
|
+
### Added
|
|
31
|
+
- BPMN parser functionality
|
|
32
|
+
- Connector system for diagram elements
|
|
33
|
+
### Changed
|
|
34
|
+
- Major project reorganization
|
|
35
|
+
- API improvements
|
|
36
|
+
|
|
37
|
+
## [0.2.0] - 2025-02-16
|
|
38
|
+
### Added
|
|
39
|
+
- Bar visualization with random heights and colors
|
|
40
|
+
- Text support for elements
|
|
41
|
+
- Analysis mode with TWEEN animations
|
|
42
|
+
### Changed
|
|
43
|
+
- Controls system with map and orbit controls
|
|
44
|
+
- Project files organization refactor
|
|
45
|
+
|
|
46
|
+
## [0.1.0] - 2025-01-23
|
|
47
|
+
### Added
|
|
48
|
+
- Basic BPMN shapes and elements
|
|
49
|
+
- Diagram modes (EDIT, VIEW)
|
|
50
|
+
- Camera controls and adjustments
|
|
51
|
+
- Map controls for EDIT mode
|
|
52
|
+
- Window resize handling
|
|
53
|
+
- Favicon support
|
|
54
|
+
|
|
55
|
+
## [0.0.1] - 2025-01-13
|
|
56
|
+
### Added
|
|
57
|
+
- Initial project setup
|
|
58
|
+
- Basic Three.js integration
|
|
59
|
+
- Project structure
|
|
60
|
+
- License
|
package/LICENSE
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
GNU GENERAL PUBLIC LICENSE
|
|
2
|
+
Version 3, 29 June 2007
|
|
3
|
+
|
|
4
|
+
Copyright (C) 2025 Robert Waszkowski
|
|
5
|
+
|
|
6
|
+
This program is free software: you can redistribute it and/or modify
|
|
7
|
+
it under the terms of the GNU General Public License as published by
|
|
8
|
+
the Free Software Foundation, either version 3 of the License, or
|
|
9
|
+
(at your option) any later version.
|
|
10
|
+
|
|
11
|
+
This program is distributed in the hope that it will be useful,
|
|
12
|
+
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
13
|
+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
14
|
+
GNU General Public License for more details.
|
|
15
|
+
|
|
16
|
+
You should have received a copy of the GNU General Public License
|
|
17
|
+
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
package/README.md
ADDED
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
# Aurea EDEN
|
|
2
|
+
|
|
3
|
+

|
|
4
|
+
|
|
5
|
+
A flexible Three.js-based framework for creating custom diagramming notations in 3D, featuring built-in BPMN support while enabling developers to define and extend their own visual languages with parameter-driven transformations.
|
|
6
|
+
|
|
7
|
+
## Table of Contents
|
|
8
|
+
|
|
9
|
+
- [Installation](#installation)
|
|
10
|
+
- [Quick Start](#quick-start)
|
|
11
|
+
- [Features](#features)
|
|
12
|
+
- [Core Components](#core-components)
|
|
13
|
+
- [Advanced Usage](#advanced-usage)
|
|
14
|
+
- [API Reference](#api-reference)
|
|
15
|
+
- [Contributing](#contributing)
|
|
16
|
+
- [License](#license)
|
|
17
|
+
|
|
18
|
+
## Installation
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npm install aurea-eden-lib
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Quick Start
|
|
25
|
+
|
|
26
|
+
```javascript
|
|
27
|
+
import { BpmnDiagram } from 'aurea-eden-lib';
|
|
28
|
+
|
|
29
|
+
// Create new diagram
|
|
30
|
+
const diagram = new BpmnDiagram(container);
|
|
31
|
+
|
|
32
|
+
// Add elements
|
|
33
|
+
diagram.addStartEvent('e1')
|
|
34
|
+
.addTask('t1')
|
|
35
|
+
.positionRightOf('e1')
|
|
36
|
+
.addWrappedText('Handle Task')
|
|
37
|
+
.connectFrom('e1')
|
|
38
|
+
.setValue(75)
|
|
39
|
+
.addValueBar();
|
|
40
|
+
|
|
41
|
+
// Arrange and display
|
|
42
|
+
diagram.arrange();
|
|
43
|
+
diagram.fitScreen();
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Features
|
|
47
|
+
|
|
48
|
+
- **3D Visualization**: Extend 2D notations into 3D space
|
|
49
|
+
- **Parameter Visualization**: Show quantitative data through value bars
|
|
50
|
+
- **Custom Notations**: Create your own visual languages
|
|
51
|
+
- **Interactive Controls**: Pan, zoom, and rotate diagrams
|
|
52
|
+
- **Multiple View Modes**: Switch between VIEW and ANALYZE modes
|
|
53
|
+
- **Fluid API**: Method chaining for intuitive diagram creation
|
|
54
|
+
- **Built-in BPMN Support**: Ready-to-use BPMN elements
|
|
55
|
+
|
|
56
|
+
## Core Components
|
|
57
|
+
|
|
58
|
+
### Diagram Class
|
|
59
|
+
|
|
60
|
+
The main container for all diagram elements:
|
|
61
|
+
|
|
62
|
+
```javascript
|
|
63
|
+
const diagram = new BpmnDiagram(container);
|
|
64
|
+
diagram.setMode('ANALYZE'); // Switch to analysis mode
|
|
65
|
+
diagram.fitScreen(); // Adjust view
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Elements
|
|
69
|
+
|
|
70
|
+
Available BPMN elements:
|
|
71
|
+
- StartEvent
|
|
72
|
+
- EndEvent
|
|
73
|
+
- Task
|
|
74
|
+
- UserTask
|
|
75
|
+
- Gateway
|
|
76
|
+
- Connector
|
|
77
|
+
|
|
78
|
+
### Materials
|
|
79
|
+
|
|
80
|
+
Three material types:
|
|
81
|
+
```javascript
|
|
82
|
+
import { DiagramMaterial, BarMaterial, EditMaterial } from 'aurea-eden-lib';
|
|
83
|
+
|
|
84
|
+
// Standard element material
|
|
85
|
+
new DiagramMaterial({
|
|
86
|
+
color: 0x00ff00,
|
|
87
|
+
shininess: 60
|
|
88
|
+
});
|
|
89
|
+
|
|
90
|
+
// Value bar material
|
|
91
|
+
new BarMaterial({
|
|
92
|
+
color: 0xff0000,
|
|
93
|
+
opacity: 0.5
|
|
94
|
+
});
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
## Advanced Usage
|
|
98
|
+
|
|
99
|
+
### Creating Custom Elements
|
|
100
|
+
|
|
101
|
+
```javascript
|
|
102
|
+
import { DiagramElement, Shape } from 'aurea-eden-lib';
|
|
103
|
+
|
|
104
|
+
class CustomElement extends DiagramElement {
|
|
105
|
+
constructor(diagram, id) {
|
|
106
|
+
super(diagram, id);
|
|
107
|
+
this.shape = new CustomShape();
|
|
108
|
+
this.add(this.shape);
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### Custom Connectors
|
|
114
|
+
|
|
115
|
+
```javascript
|
|
116
|
+
const waypoints = [
|
|
117
|
+
element1.getNorthPoint(),
|
|
118
|
+
{ x: 100, y: 200, z: 0 },
|
|
119
|
+
element2.getSouthPoint()
|
|
120
|
+
];
|
|
121
|
+
|
|
122
|
+
diagram.addFlowConnector('connector1', waypoints);
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
## API Reference
|
|
126
|
+
|
|
127
|
+
### BpmnDiagram Methods
|
|
128
|
+
|
|
129
|
+
#### Element Creation
|
|
130
|
+
- `addStartEvent(id)`
|
|
131
|
+
- `addEndEvent(id)`
|
|
132
|
+
- `addTask(id)`
|
|
133
|
+
- `addUserTask(id)`
|
|
134
|
+
- `addGateway(id)`
|
|
135
|
+
|
|
136
|
+
#### Element Positioning
|
|
137
|
+
- `positionRightOf(elementId)`
|
|
138
|
+
- `positionBelow(elementId)`
|
|
139
|
+
- `positionUpRightOf(elementId)`
|
|
140
|
+
- `positionDownRightOf(elementId)`
|
|
141
|
+
|
|
142
|
+
#### View Control
|
|
143
|
+
- `center()`
|
|
144
|
+
- `fitScreen()`
|
|
145
|
+
- `rotate(angle)`
|
|
146
|
+
- `setMode(mode)`
|
|
147
|
+
|
|
148
|
+
## Contributing
|
|
149
|
+
|
|
150
|
+
1. Fork the repository
|
|
151
|
+
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
|
|
152
|
+
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
|
|
153
|
+
4. Push to the branch (`git push origin feature/AmazingFeature`)
|
|
154
|
+
5. Open a Pull Request
|
|
155
|
+
|
|
156
|
+
## License
|
|
157
|
+
|
|
158
|
+
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
|
|
159
|
+
|
|
160
|
+
## Dependencies
|
|
161
|
+
|
|
162
|
+
- Three.js: 3D graphics library
|
|
163
|
+
- Tween.js: Animation library
|
|
164
|
+
|
|
165
|
+
## Author
|
|
166
|
+
|
|
167
|
+
Robert Waszkowski
|
|
168
|
+
|
|
169
|
+
---
|
|
170
|
+
|
|
171
|
+
For more examples and detailed API documentation, visit our [GitHub Wiki](https://github.com/your-repo/aurea-eden/wiki).
|
package/README_.md
ADDED
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
# Aurea EDEN
|
|
2
|
+
|
|
3
|
+

|
|
4
|
+
|
|
5
|
+
## Libraries used
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
npm install --save three
|
|
9
|
+
npm install @tweenjs/tween.js
|
|
10
|
+
npm install --save-dev vite
|
|
11
|
+
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Run
|
|
15
|
+
### Vite
|
|
16
|
+
```
|
|
17
|
+
npx vite
|
|
18
|
+
```
|
|
19
|
+
and open the local site: [http://localhost:5173/](http://localhost:5173/)
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
### Build and run
|
|
23
|
+
```
|
|
24
|
+
npm run build
|
|
25
|
+
npx vite
|
|
26
|
+
```
|
|
27
|
+
and open the local site [http://localhost:5173/use-lib.html](http://localhost:5173/use-lib.html)
|
|
28
|
+
|
|
29
|
+
## Getting started
|
|
30
|
+
|
|
31
|
+
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
|
32
|
+
|
|
33
|
+
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
|
34
|
+
|
|
35
|
+
## Add your files
|
|
36
|
+
|
|
37
|
+
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
|
38
|
+
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
cd existing_repo
|
|
42
|
+
git remote add origin https://gitlab.tecna.pl/waszkowski_r/three-diagram.git
|
|
43
|
+
git branch -M master
|
|
44
|
+
git push -uf origin master
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Git configuration
|
|
48
|
+
|
|
49
|
+
You can view all of your settings and where they are coming from using:
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
$ git config --list --show-origin
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Your Identity
|
|
56
|
+
The first thing you should do when you install Git is to set your user name and email address. This is important because every Git commit uses this information, and it’s immutably baked into the commits you start creating:
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
$ git config --global user.name "John Doe"
|
|
60
|
+
$ git config --global user.email johndoe@example.com
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Avoid Repeated Credential Prompts
|
|
64
|
+
|
|
65
|
+
If you want VS Code to stop asking for credentials every time you push your changes to GitLab, follow this step:
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
git config credential.helper store
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Integrate with your tools
|
|
72
|
+
|
|
73
|
+
- [ ] [Set up project integrations](https://gitlab.tecna.pl/waszkowski_r/three-diagram/-/settings/integrations)
|
|
74
|
+
|
|
75
|
+
## Collaborate with your team
|
|
76
|
+
|
|
77
|
+
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
|
78
|
+
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
|
79
|
+
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
|
80
|
+
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
|
81
|
+
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
|
82
|
+
|
|
83
|
+
## Test and Deploy
|
|
84
|
+
|
|
85
|
+
Use the built-in continuous integration in GitLab.
|
|
86
|
+
|
|
87
|
+
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
|
|
88
|
+
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
|
89
|
+
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
|
90
|
+
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
|
91
|
+
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
|
92
|
+
|
|
93
|
+
***
|
|
94
|
+
|
|
95
|
+
# Editing this README
|
|
96
|
+
|
|
97
|
+
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
|
98
|
+
|
|
99
|
+
## Suggestions for a good README
|
|
100
|
+
|
|
101
|
+
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
|
102
|
+
|
|
103
|
+
## Name
|
|
104
|
+
Choose a self-explaining name for your project.
|
|
105
|
+
|
|
106
|
+
## Description
|
|
107
|
+
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
|
108
|
+
|
|
109
|
+
## Badges
|
|
110
|
+
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
|
111
|
+
|
|
112
|
+
## Visuals
|
|
113
|
+
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
|
114
|
+
|
|
115
|
+
## Installation
|
|
116
|
+
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
|
117
|
+
|
|
118
|
+
## Usage
|
|
119
|
+
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
|
120
|
+
|
|
121
|
+
## Support
|
|
122
|
+
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
|
123
|
+
|
|
124
|
+
## Roadmap
|
|
125
|
+
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
|
126
|
+
|
|
127
|
+
## Contributing
|
|
128
|
+
State if you are open to contributions and what your requirements are for accepting them.
|
|
129
|
+
|
|
130
|
+
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
|
131
|
+
|
|
132
|
+
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
|
133
|
+
|
|
134
|
+
## Authors and acknowledgment
|
|
135
|
+
Show your appreciation to those who have contributed to the project.
|
|
136
|
+
|
|
137
|
+
## License
|
|
138
|
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
139
|
+
|
|
140
|
+
## Project status
|
|
141
|
+
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
|
142
|
+
|
|
143
|
+
# Acknowledgment
|
|
144
|
+
The library structure and behavior are inspired by Sameer Kumar's sample JavaScript Vite library. For more details, visit the [GitHub repository](https://github.com/sameer1612/ninja-lib) and the [preparation guide](https://betterprogramming.pub/the-pragmatic-guide-to-your-first-javascript-library-516a7b08c677).
|
|
145
|
+
|
|
146
|
+
Useful Three.js Tutorial [here](https://sbcode.net/threejs/)
|
|
147
|
+
(i.e. [OrbitControls](https://sbcode.net/threejs/orbit-controls/)).
|
|
148
|
+
|
|
149
|
+
Drawing technology flow chart [orthogonal connection algorithm](https://pubuzhixing.medium.com/drawing-technology-flow-chart-orthogonal-connection-algorithm-fe23215f5ada).
|
|
150
|
+
Routing [Orthogonal Diagram Connectors in JavaScript](https://medium.com/swlh/routing-orthogonal-diagram-connectors-in-javascript-191dc2c5ff70).
|
|
151
|
+
Orthogonal Connector Routing example [here](https://orthogonal.jose.page/).
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
For testing
|
|
156
|
+
|
|
157
|
+
$ npm install --save dat.gui
|
|
158
|
+
|
|
159
|
+
https://github.com/dataarts/dat.gui
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
**Adding automated versioning**
|
|
163
|
+
|
|
164
|
+
https://muetsch.io/mastering-software-versioning-in-javascript-projects.html
|
|
165
|
+
|
|
166
|
+
Install:
|
|
167
|
+
```terminal
|
|
168
|
+
npm i --save-dev standard-version
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
Set a new version:
|
|
172
|
+
```terminal
|
|
173
|
+
npm run release
|
|
174
|
+
```
|
|
Binary file
|
|
Binary file
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
This favicon was generated using the following graphics from Twitter Twemoji:
|
|
2
|
+
|
|
3
|
+
- Graphics Title: 2197.svg
|
|
4
|
+
- Graphics Author: Copyright 2020 Twitter, Inc and other contributors (https://github.com/twitter/twemoji)
|
|
5
|
+
- Graphics Source: https://github.com/twitter/twemoji/blob/master/assets/svg/2197.svg
|
|
6
|
+
- Graphics License: CC-BY 4.0 (https://creativecommons.org/licenses/by/4.0/)
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|