Skip to content

Latest commit

 

History

History
83 lines (67 loc) · 3.04 KB

COMMANDS.md

File metadata and controls

83 lines (67 loc) · 3.04 KB

What is this?

This document contains all custom commands that you can use within this application during development stage.

Table of Contents

Makefile ᐞ

This project contains Makefile configuration so that you can easily run some generic commands via make command. Below is a list of currently supported make commands, note that you can get this same list with just running make command:

bash                      # Get bash inside Node container
check-translations        # Check missing translations
docker-kill-containers    # Kill all running docker containers
docker-remove-containers  # Remove all docker containers
docker-remove-images      # Remove all docker images
extract-translations      # Extract translations from TypeScript and HTML
                          # template files
fish                      # Get fish inside Node container
fix                       # Fix TypeScript and SCSS files
fix-scss                  # Fix SCSS files
fix-ts                    # Fix TypeScript files
generate-ssl-cert         # Generate self signed SSL certificate
lint                      # Lint TypeScript and SCSS files
lint-scss                 # Lint SCSS files
lint-ts                   # Lint TypeScript files
project-stats             # Create simple project stats
start-build               # Start application in development mode and build
                          # containers
start-production          # Start application locally in production mode
start                     # Start application in development mode
start-yarn-prod           # Run start-prod command with yarn
start-yarn                # Run start command with yarn
stop                      # Stop application containers
update                    # Upgrade dependencies via yarn interactively

Example:

da_wunder@wunder-VirtualBox:~/PhpstormProjects/angular-ngrx-frontend$ make bash
node@84a0da4d1c84:/app$

Yarn ᐞ

This project contains some custom scripts that are defined in packages.json file that you can easily run just by using yarn _command_here_. Note that these yarn commands are mean to run inside Docker container, so first use make bash command to get shell inside container.

Below you can see a list of all those custom commands that you most likely need to use at some point of development process:

extract-translations    # Extract translations, see TRANSLATIONS.md
lint:scss               # Lint SCSS files by https://stylelint.io/
lint:ts                 # Lint TS files by https://palantir.github.io/tslint/

Example:

da_wunder@wunder-VirtualBox:~/PhpstormProjects/angular-ngrx-frontend$ make bash
node@84a0da4d1c84:/app$ yarn lint:scss
yarn run v1.22.4
$ npx stylelint '**/*.scss'
Done in 2.06s.
node@84a0da4d1c84:/app$

Back to resources index - Back to main README.md