mirror of
				https://github.com/avatao-content/frontend-tutorial-framework
				synced 2025-11-04 05:32:55 +00:00 
			
		
		
		
	Remove autogenerated bullshit from README.md and add actual infos
This commit is contained in:
		
							
								
								
									
										28
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										28
									
								
								README.md
									
									
									
									
									
								
							@@ -1,27 +1,13 @@
 | 
				
			|||||||
# TutorialFrameworkNg
 | 
					Tutorial Framework Frontend
 | 
				
			||||||
 | 
					===========================
 | 
				
			||||||
 | 
					
 | 
				
			||||||
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 1.6.1.
 | 
					## Building and running with magic starter
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Development server
 | 
					Execute the `tfw_magic_start.sh` script and it will automagically run a backend instance in Docker and serve the Angular frontend locally.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
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.
 | 
					This requires the `tutorial-framework-wip` and `tutorial-framework-ng` repositories to have a common parent folder.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Code scaffolding
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
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`.
 | 
					## Running with yarn
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Build
 | 
					Simply execute `yarn start` in the project root.
 | 
				
			||||||
 | 
					 | 
				
			||||||
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.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Running unit tests
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Running end-to-end tests
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Further help
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
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).
 | 
					 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user