Aden Hassan a7aa94e084 Merge pull request #132 in TEA/mina-sidor-fa-web from feature/TV-591 to develop
Squashed commit of the following:

commit 92501f038a2e9d43a62ee7ef606fe8ff95b3a994
Author: Chingiz <chingiz.esenbaev@arbetsformedlingen.se>
Date:   Mon Sep 27 10:06:56 2021 +0200

    updating models, services, api

commit bc9815f457ef4e80e40e3f0ea9f0f71d14cf5c65
Author: Chingiz <chingiz.esenbaev@arbetsformedlingen.se>
Date:   Mon Sep 27 07:07:34 2021 +0200

    updated html file

commit a5842fd33b9909679c091d7b2657eb7d8cd2e094
Merge: 1b51bf6 85242b0
Author: Chingiz <chingiz.esenbaev@arbetsformedlingen.se>
Date:   Mon Sep 27 06:56:01 2021 +0200

    Merge branch 'develop' into feature/TV-591

commit 1b51bf6c73e831b6b0f46c0b75b09c86f813b237
Author: Chingiz <chingiz.esenbaev@arbetsformedlingen.se>
Date:   Mon Sep 27 06:55:26 2021 +0200

    base structure done

commit fd0900411a0365d9c92337ab5ee7c8fae4282fe3
Merge: 4333891 9bedbd3
Author: Chingiz <chingiz.esenbaev@arbetsformedlingen.se>
Date:   Thu Sep 23 16:44:11 2021 +0200

    Merge branch 'develop' into feature/TV-591

commit 43338914fa67d40357f68d20ef2d6fe0cb19e218
Author: Chingiz <chingiz.esenbaev@arbetsformedlingen.se>
Date:   Thu Sep 23 16:43:42 2021 +0200

    formgroup and more

commit 96086b08b10ca785d3271e38e5cd81cade91acf0
Merge: d263f27 5846c2c
Author: Chingiz <chingiz.esenbaev@arbetsformedlingen.se>
Date:   Tue Sep 21 19:57:06 2021 +0200

    Merge branch 'develop' into feature/TV-591

commit d263f270c643cc0a8f36a1edb4f87813b1916eba
Author: Chingiz <chingiz.esenbaev@arbetsformedlingen.se>
Date:   Tue Sep 21 19:56:24 2021 +0200

    sÃparar filer innan merge

commit 4352b00d0eed60ea2703b5a3957a608ee053e8d3
Author: Chingiz <chingiz.esenbaev@arbetsformedlingen.se>
Date:   Mon Sep 20 10:58:12 2021 +0200

    updating to match other tasks

commit d51e22bc8a61e67cec711eb4915c3a381eb67aaf
Author: Chingiz <chingiz.esenbaev@arbetsformedlingen.se>
Date:   Thu Sep 16 18:52:25 2021 +0200

    Created some base-structure
2021-09-27 12:33:47 +02:00
2021-09-08 07:09:12 +02:00
2021-03-16 13:00:57 +01:00
2021-09-13 15:28:33 +02:00
2021-03-16 13:00:57 +01:00
2021-03-16 13:11:11 +01:00
2021-05-04 15:55:21 +02:00
2021-03-16 13:00:57 +01:00
2021-09-03 15:52:29 +02:00
2021-09-24 14:19:26 +02:00
2021-03-16 13:00:57 +01:00
2021-03-16 13:00:57 +01:00
2021-09-01 15:06:59 +02:00
2021-09-24 14:20:39 +02:00
2021-09-06 10:59:35 +02:00

mina-sidor-fa

The project was generated using Nx.

Quick Start & Documentation

For all commands we will refer to the npm scripts located inside package.json. When using these commands, you do not need to have @angular/cli installed globally on your computer.

To get started, clone the repository and run npm install in the root of the project, this will install all dependencies.

Development server mina-sidor-fa

Run npm start for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Dotnet API

Run npm run start:api to run against the Dotnet API.

Generate an application

Run npm run new-app my-app to generate an application. When using Nx, you can create multiple applications and libraries in the same workspace.

Generate a library

Run npm run new-lib my-lib to generate a library. Libraries are shareable across libraries and applications. They can be imported from @mina-sidor-fa/mylib.

Code scaffolding

Run npm run new-component my-component --project=my-app to generate a new component.

Build mina-sidor-fa

Run npm run build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Mock-api

If you want to use the mock-api, read the README here.

Dotnet API

Run npm run build:api to build the project using the Dotnet API.

Running unit tests on mina-sidor-fa

Run npm run test to execute the unit tests via Jest.

Run npm run nx affected:test to execute the unit tests affected by a change.

Running end-to-end tests on mina-sidor-fa

Run npm run e2e to execute the end-to-end tests via Cypress.

Run npm run nx affected:e2e to execute the end-to-end tests affected by a change.

Understand your workspace

Run npm run nx dep-graph to see a diagram of the dependencies of your projects.

Git workflow

  • Use branching model Gitflow.

    • Example: feature/TV-XXXX or bugfix/TV-XXXX
    • A useful CLI helper tool can be used: gitflow-avh.
  • Clone origin, create feature/bugfix branches and push back to origin.

  • Don't forget to commit and push your changes regulary!

  • Create a pull request for each feature branch.

  • When merging the pull request, follow conventional commits structure inside the merge message.

    • The merge-message, which follows conventional commits, will be added to the CHANGELOG after a release is made.

    • A commit message could look like this: feat(startpage): Added headings and description to the startpage (TV-1234).

    • The changelog would look something like this:

      ### Features
      
      - **startpage:** Added headings and description to the startpage ([TV-1234](https://jira.arbetsformedlingen.se/browse/TV-1234)) ([commit-hash](https://bitbucket.arbetsformedlingen.se/projects/tea/repos/mina-sidor-fa-web/commits/commit-hash))
      
  • Upon merge, Open Shift will deploy the application to AUTO and SYS.

Release and deploy

We use a semi-automated release and deploy to different test-enviroments. A release script is used in combination with semantic-release to add the correct version of the application and changes to the changelog. The deployments are made depending on which branches are updated:

  • develop is automatically deployed to AUTO and SYS.
  • next is automatically deployed to TEST.
  • main is automatically deployed to ACC. After this is completed, a question needs to be answered whether the image should be deployed to PROD.

Deploy to TEST

To deploy the application to TEST you need to create a release. Make sure you are in the develop branch and are up-to-date with origin. Then run npm run release. This will:

  • Update the CHANGELOG.md and copies the CHANGELOG to assets.
  • Bump the applications version according to semantic versioning.
  • Commits the CHANGELOG to develop and pushes it to origin.
  • Merge develop into next and pushes next to origin.

Open Shift will deploy the application to TEST.

Release to ACC and PROD

To release the latest version of next to ACC and eventually to PROD; a pull request should be created to merge next into main. The next branch is protected and will not be deleted upon merge.

Open Shift will deploy the application to ACC and a question inside the pipeline is asked if the application also should be deployed to PROD. This question will persist for 24 hours.

General Nx documentation

Nx Documentation

10-minute video showing all Nx features

Interactive Tutorial

Description
No description provided
Readme 3.8 MiB
Languages
TypeScript 64.6%
HTML 18.9%
JavaScript 8.9%
SCSS 6.3%
Groovy 0.8%
Other 0.5%