|
1 | | -# angular-animation-framework |
2 | | -THREE.js Animation Framework as Angular component |
| 1 | +# Angular Animation Framework |
| 2 | + |
| 3 | +| Frameworks | | Links | |
| 4 | +| ---:| :--- | :--- | |
| 5 | +| <img src="https://angular.io/assets/images/logos/angular/angular.svg" height="64" alt="Angular Logo" /><br>Angular CLI | Client Side TypeScript App | [WEBSITE](https://angular.io)<br> [README](https://github.com/angular/angular-cli/blob/master/README.md)| |
| 6 | +| <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/2/25/WebGL_Logo.svg/1199px-WebGL_Logo.svg.png" height="64" alt="WebGL Logo" /><br>Three-js | 3D Graphic API | [WEBSITE](https://threejs.org/)<br> [README](https://github.com/mrdoob/three.js/blob/dev/README.md)| |
| 7 | + |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | +<a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-nd/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/">Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License</a>. |
| 12 | +###### *© 2020 - Moritz Petzka - [petzka.com](https://petzka.com/)* |
| 13 | +This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 9.0.5. |
| 14 | + |
| 15 | +## Installation |
| 16 | + |
| 17 | +Run `npm install -g @angular/cli` to install Angular CLI. |
| 18 | +Run `npm install` to install dependencies. |
| 19 | + |
| 20 | + |
| 21 | +## Development server |
| 22 | + |
| 23 | +Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. |
| 24 | + |
| 25 | +## Code scaffolding |
| 26 | + |
| 27 | +Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`. |
| 28 | + |
| 29 | +## Build |
| 30 | + |
| 31 | +Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build. |
| 32 | + |
| 33 | +## Running unit tests |
| 34 | + |
| 35 | +Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). |
| 36 | + |
| 37 | +## Running end-to-end tests |
| 38 | + |
| 39 | +Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/). |
| 40 | + |
| 41 | +## Further help |
| 42 | + |
| 43 | +To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md). |
| 44 | + |
| 45 | + |
| 46 | +# Important Files |
| 47 | + |
| 48 | + * [/src/](./src) |
| 49 | + * [/app/..](./src/app) |
| 50 | + * [/three-animation/](./src/app/three-animation) <sub><sup>THREE.js animation framework component</sup></sub> |
| 51 | + * [three-animation.component.ts](./src/app/three-animation/three-animation.component.ts) <sub><sup>main component</sup></sub> |
| 52 | + * [/start-animation/](./src/app/start-animation) <sub><sup>demo component - how to</sup></sub> |
| 53 | + * [start-animation.component.ts](./src/app/start-animation/start-animation.component.ts) |
| 54 | + |
| 55 | + - - - |
| 56 | +# Other Helpful Deployment Stuff |
| 57 | +```bash |
| 58 | +# pull with docker |
| 59 | +$ docker pull mopet/tator:latest |
| 60 | + |
| 61 | +# pull with npm: |
| 62 | +$ npm run docker:pull |
| 63 | + |
| 64 | + |
| 65 | + |
| 66 | +# build with docker |
| 67 | +$ docker build -t mopet/tator:latest . |
| 68 | + |
| 69 | +# build with npm: |
| 70 | +$ npm run docker:build |
| 71 | + |
| 72 | + |
| 73 | + |
| 74 | +# run image with docker |
| 75 | +$ docker run -p 3000:3000 mopet/tator:latest |
| 76 | + |
| 77 | +# run image w with npm: |
| 78 | +$ npm run docker:build |
| 79 | +``` |
| 80 | + |
| 81 | +#### for killing all current running docker container / images: |
| 82 | + |
| 83 | +```bash |
| 84 | +# List Images |
| 85 | +$ docker ps -a |
| 86 | + |
| 87 | +# Stop All Container |
| 88 | +$ docker stop $(docker ps -a -q) |
| 89 | + |
| 90 | +# Remove All Container |
| 91 | +$ docker rm $(docker ps -a -q) |
| 92 | + |
| 93 | +# Remove All Images |
| 94 | +$ docker rmi $(docker images -q) |
| 95 | + |
| 96 | +# All In One |
| 97 | +$ docker stop $(docker ps -a -q) && docker rm $(docker ps -a -q) && docker rmi $(docker images -q) |
| 98 | +``` |
| 99 | + |
| 100 | +#### Installation - npm only (without docker) |
| 101 | + |
| 102 | +```bash |
| 103 | +# NestJS Server |
| 104 | +$ npm install |
| 105 | + |
| 106 | +# Angular App |
| 107 | +$ cd tator-app/ |
| 108 | +$ npm install |
| 109 | +``` |
| 110 | + |
| 111 | +#### Build App - npm only (without docker) |
| 112 | + |
| 113 | +```bash |
| 114 | +# NestJS Server |
| 115 | +$ npm run build |
| 116 | + |
| 117 | +# Angular App |
| 118 | +$ npm run ng:build |
| 119 | +``` |
| 120 | + |
| 121 | +#### Serve Dev Mode (Angular) |
| 122 | + |
| 123 | +```bash |
| 124 | +# ng serve (with proxies) |
| 125 | +$ npm run ng:serve |
| 126 | +``` |
| 127 | + |
| 128 | +#### Running The Server (NestJS) |
| 129 | + |
| 130 | +```bash |
| 131 | +# development |
| 132 | +$ npm run start |
| 133 | + |
| 134 | +# watch mode |
| 135 | +$ npm run start:dev |
| 136 | + |
| 137 | +# production mode |
| 138 | +$ npm run start:prod |
| 139 | +``` |
0 commit comments