baiganio.github.io
- This project aims self-creativity & is nothing but a playground where development skills are challenged for fun!!
- This app turns out to be somehow a portfolio for the collaborators & a workbench for testing new technologies ;)
Getting started (local environment setup)
- Execute
node -v
to check your current Node.js version - Run
npm install
- Execite
ng v
to see project current Angular CLI & TypeScript versions - Run
npm run start:test
to work directly with https://test-bgapi.azurewebsites.net/npm run start
or alternativelyng serve -c=local -o
if you have BGAPI project locally- Both commands will start the application wich then opens automatically at
http://localhost:5003/
- Both commands will start the application wich then opens automatically at
Build
-
Run
ng build
for a local build -
Run
ng build -c=prod
for a production build *- build artifacts are stored in the
dist/
folder - ensure tests passes before that
- build artifacts are stored in the
-
Initially the prject came with pre defined environment variables configured in environment.*.ts files.
-
Production Build Artifacts
for your own usage is better to be done after configuring environment.prod.ts.- Details &
how to?
can be read in Configuring-Environment-Variables wiki page.
- Details &
Deploy
We use GitHub Actions to automate our CI/CD pipeline.
Build Workflow
is triggered on push or pull-request against master branch.- Configuration could be found in build-and-publish-artifacts.yml file
Reusable Deploy Workflow
runs once build artifacts are published.- Configuration could be found in gh-pages-deploy.yml file
- Manual deployment for own usage could be found in the below wiki pages:
- Configuring-GitHub-Pages-Production-Deploy
- TODO:
Azure Websites Production Deploy
Running unit tests & measure code coverage*
Karma is out of the box test runner, as well as Jasmine like a testing framework. We use several ways to work with the tests in the project.
- Run
ng test
- to execute the unit tests & explore results in the terminal (only)npm run test
- to execute the unit tests & explore the results in the browsernpm run test:headless
- unit tests execution result is visible in the terminal & no browser is open
- used in workflow pipeline
Check this Unit-Testing-Setup-in-Angular wiki page on how to?
:
- configure karma.config.js & package.json files
- investigate and measure code coverage report
Running end-to-end tests
- Run
ng e2e
to execute the end-to-end tests via Protractor.
Running lint
- Run
npm run lint
to check if the set of rules is covered.- Do linting before pushing to
master
or openning apull-request
- Do linting before pushing to
Build Pipeline
breaks if linting fails.
Further help & Issues
- On
how to
andwhere from
on the project use - check out our Wiki - To help us better organizing our work and provide us information faster - use one of our pre-filled issue templates*
*requires GitHub account