Skip to content

Commit 574ecf3

Browse files
committed
Align the Angular version readme
1 parent 4f052d1 commit 574ecf3

File tree

8 files changed

+375
-525
lines changed

8 files changed

+375
-525
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# A simplified Jira clone built with Angular 10, Akita and ng-zorro
1+
# A simplified Jira clone built with Angular, Akita and ng-zorro
22

33
> Phase two will not be completed as planned. Both [Chau Tran][chau] and I was too busy with some other commitments. View our [working in progress Graph QL branch][gql].
44
>
@@ -8,13 +8,13 @@
88
99
There have been a handful of cool Jira-cloned apps written in `React`/`VueJS`, which makes me wonder **Why not Angular**? And here you go.
1010

11-
This is not only a simplified Jira clone built with Angular 9, but also an example of a **modern**, **real-world** Angular codebase.
11+
This is not only a simplified Jira clone built with Angular, but also an example of a **modern**, **real-world** Angular codebase.
1212

1313
<details>
1414
<summary>Table Of Content</summary>
1515
<p>
1616

17-
- [A simplified Jira clone built with Angular 10, Akita and ng-zorro](#a-simplified-jira-clone-built-with-angular-10-akita-and-ng-zorro)
17+
- [A simplified Jira clone built with Angular, Akita and ng-zorro](#a-simplified-jira-clone-built-with-angular-akita-and-ng-zorro)
1818
- [Merry Christmas](#merry-christmas)
1919
- [Working application](#working-application)
2020
- [Storybook](#storybook)
@@ -50,13 +50,13 @@ This is not only a simplified Jira clone built with Angular 9, but also an examp
5050

5151
Thank you for your support! -> https://jira.trungk18.com/project/issue/2020
5252

53-
![Jira clone built with Angular 9 and Akita][christmas2020]
53+
![Jira clone built with Angular and Akita][christmas2020]
5454

5555
## Working application
5656

5757
Check out the **live demo** -> https://jira.trungk18.com
5858

59-
![Jira clone built with Angular 9 and Akita][demo]
59+
![Jira clone built with Angular and Akita][demo]
6060

6161
## Storybook
6262

@@ -77,7 +77,7 @@ This is the collection of components that I wrote for [jira.trungk18.com][jira],
7777

7878
Check out the **storybook demo** -> https://jira-storybook.trungk18.com/
7979

80-
![Jira clone built with Angular 9 and Akita][demo-storybook]
80+
![Jira clone built with Angular and Akita][demo-storybook]
8181

8282
## Support
8383

@@ -138,7 +138,7 @@ As requested by [@eric_cart][eric_cart], I draw a simple high-level design for t
138138

139139
I have an AppModule that will import:
140140

141-
![Jira clone built with Angular 9 and Akita - Application architecture][application-architecture]
141+
![Jira clone built with Angular and Akita - Application architecture][application-architecture]
142142

143143
- Angular needed modules such as `BrowserModule` and any module that need to run `forRoot`.
144144
- The application core modules such as `AuthModule` that need to available on the whole platform.
@@ -149,7 +149,7 @@ I have an AppModule that will import:
149149

150150
As I am using [Akita][akita] state management, I follow the Akita documentation for the data flow. I found it is simple to understand comparing with ngrx terms (`reducer`, `selector`, `effect`)
151151

152-
![Jira clone built with Angular 9 and Akita - Simple data interaction flow][interaction-data-flow]
152+
![Jira clone built with Angular and Akita - Simple data interaction flow][interaction-data-flow]
153153

154154
I set up a [project state with initial data][project-store]. The main heavy lifting part I think is the [project service][project-service], it contains all the interacting with [project store][project-store]. Such as after fetching the project successfully, I update the store immediately inside the service itself. The last lego block was to expose the data through [project query][project-query]. Any components can start to inject [project query][project-query] and consume data from there.
155155

@@ -239,7 +239,7 @@ According to waka time report, I have spent about 45 hours working on this proje
239239

240240
I really enjoyed working on this project. The interactive kanban board took me sometimes, it is challenging but exciting at the same time.
241241

242-
![Jira clone built with Angular 9 and Akita - Time spending][time]
242+
![Jira clone built with Angular and Akita - Time spending][time]
243243

244244
## What's currently missing?
245245

frontend/documentation.json

Lines changed: 346 additions & 496 deletions
Large diffs are not rendered by default.

frontend/src/app/project/components/navigation/navbar-left/navbar-left.component.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<div class="navbarLeft-content">
33
<div class="logoLink"
44
title="Angular Jira Clone by trungk18">
5-
<svg class="h-8 w-8 text-textLogo"
5+
<svg class="w-8 h-8 text-textLogo"
66
viewBox="0 0 32 32"
77
xmlns="http://www.w3.org/2000/svg"
88
aria-hidden="true">
@@ -48,7 +48,7 @@
4848
[nzTooltipTitle]="item.tooltip"
4949
nzTooltipPlacement="right"
5050
class="itemIcon">
51-
<i class="text-white text-xl"
51+
<i class="text-xl text-white"
5252
nz-icon
5353
[nzType]="item.icon"
5454
nzTheme="outline"></i>
@@ -76,7 +76,7 @@
7676
nzTooltipTitle="About"
7777
nzTooltipPlacement="right"
7878
class="itemIcon">
79-
<i class="text-white text-xl"
79+
<i class="text-xl text-white"
8080
nz-icon
8181
nzType="question-circle"
8282
nzTheme="fill">
@@ -89,7 +89,7 @@
8989

9090
<ng-template #aboutPopoverTmpl>
9191
<div class="about-popover">
92-
<p class="mb-2">This is a <strong>simplified</strong> Jira clone built with Angular 9, Akita and ng-zorro</p>
92+
<p class="mb-2">This is a <strong>simplified</strong> Jira clone built with Angular, Akita and ng-zorro</p>
9393
<p class="mb-2">Thanks a bunch for stopping by and supporting me!</p>
9494
<p class="mb-3">Reach out to me via <a class="font-semibold"
9595

frontend/src/app/work-in-progress/work-in-progress.component.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
<div class="container mx-auto p-5">
2-
<h1 class="text-3xl text-center">A simplified Jira clone built with Angular 9 and Akita</h1>
1+
<div class="container p-5 mx-auto">
2+
<h1 class="text-3xl text-center">A simplified Jira clone built with Angular and Akita</h1>
33

4-
<img class="mx-auto w-auto md:max-w-2xl"
4+
<img class="w-auto mx-auto md:max-w-2xl"
55
src="assets/img/jira-clone-tech-stack.png" />
66

7-
<h3 class="text-center m-10">
7+
<h3 class="m-10 text-center">
88
<a class="text-lg text-blue-500 hover:text-blue-800"
99
href="https://jira.trungk18.com/">Visit the work in progress app</a> |
1010
<a class="text-lg text-blue-500 hover:text-blue-800"
1111
href="hhttps://github.com/trungk18/jira-clone-angular/tree/master/frontend">View front-end code</a>
1212
</h3>
1313

14-
<div class="bg-teal-100 border-t-4 border-teal-500 rounded-b text-teal-900 px-4 py-3 shadow-md"
14+
<div class="px-4 py-3 text-teal-900 bg-teal-100 border-t-4 border-teal-500 rounded-b shadow-md"
1515
role="alert">
1616
<div class="flex">
17-
<div class="py-1"><svg class="fill-current h-6 w-6 text-teal-500 mr-4"
17+
<div class="py-1"><svg class="w-6 h-6 mr-4 text-teal-500 fill-current"
1818
xmlns="http://www.w3.org/2000/svg"
1919
viewBox="0 0 20 20">
2020
<path d="M2.93 17.07A10 10 0 1 1 17.07 2.93 10 10 0 0 1 2.93 17.07zm12.73-1.41A8 8 0 1 0 4.34 4.34a8 8 0 0 0 11.32 11.32zM9 11V9h2v6H9v-4zm0-6h2v2H9V5z" /></svg></div>

frontend/src/assets/data/project.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@
185185
{
186186
"id": "9584",
187187
"title": "What is Angular Jira clone application?",
188-
"description": "<p>There have been a handful of cool Jira-cloned apps written in React/VueJS, which makes me wonder <strong>Why not Angular</strong>? And here you go.</p><p><br></p><p>This is <u>not only</u> a simplified Jira clone built with Angular 9, but also an example of a <u>modern, real-world</u> Angular codebase.</p><p><br></p><p><strong>Tech stack</strong></p><p><br></p><p><a href='https://raw.githubusercontent.com/trungk18/jira-clone-angular/master/frontend/src/assets/img/jira-clone-tech-stack.png' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214); background-color: rgb(255, 255, 255);'><img src='https://github.com/trungk18/jira-clone-angular/raw/master/frontend/src/assets/img/jira-clone-tech-stack.png' alt='Tech logos'></a></p><p><br></p><ul><li><a href='https://cli.angular.io/' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214);'>Angular CLI</a></li><li><a href='https://datorama.github.io/akita/' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214);'>Akita</a>&nbsp;state management</li><li><a href='https://nestjs.com/' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214);'>NestJS</a></li><li>UI modules:</li><li class='ql-indent-1'><a href='https://tailwindcss.com/' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214);'>TailwindCSS</a></li><li class='ql-indent-1'>Angular CDK&nbsp;<a href='https://material.angular.io/cdk/drag-drop/overview' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214);'>drag and drop</a></li><li class='ql-indent-1'><a href='https://ng.ant.design/docs/introduce/en' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214);'>ng-zorro</a>&nbsp;UI component:&nbsp;<code style='background-color: rgba(27, 31, 35, 0.05);'>tooltip</code>,&nbsp;<code style='background-color: rgba(27, 31, 35, 0.05);'>modal</code>,&nbsp;<code style='background-color: rgba(27, 31, 35, 0.05);'>select</code>,&nbsp;<code style='background-color: rgba(27, 31, 35, 0.05);'>icon</code> and more.</li><li class='ql-indent-1'><a href='https://github.com/KillerCodeMonkey/ngx-quill' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214);'>ngx-quill</a></li><li><a href='https://www.netlify.com/' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214);'>Netlify</a></li><li><a href='https://www.heroku.com/' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214);'>Heroku</a></li></ul>",
188+
"description": "<p>There have been a handful of cool Jira-cloned apps written in React/VueJS, which makes me wonder <strong>Why not Angular</strong>? And here you go.</p><p><br></p><p>This is <u>not only</u> a simplified Jira clone built with Angular, but also an example of a <u>modern, real-world</u> Angular codebase.</p><p><br></p><p><strong>Tech stack</strong></p><p><br></p><p><a href='https://raw.githubusercontent.com/trungk18/jira-clone-angular/master/frontend/src/assets/img/jira-clone-tech-stack.png' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214); background-color: rgb(255, 255, 255);'><img src='https://github.com/trungk18/jira-clone-angular/raw/master/frontend/src/assets/img/jira-clone-tech-stack.png' alt='Tech logos'></a></p><p><br></p><ul><li><a href='https://cli.angular.io/' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214);'>Angular CLI</a></li><li><a href='https://datorama.github.io/akita/' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214);'>Akita</a>&nbsp;state management</li><li><a href='https://nestjs.com/' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214);'>NestJS</a></li><li>UI modules:</li><li class='ql-indent-1'><a href='https://tailwindcss.com/' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214);'>TailwindCSS</a></li><li class='ql-indent-1'>Angular CDK&nbsp;<a href='https://material.angular.io/cdk/drag-drop/overview' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214);'>drag and drop</a></li><li class='ql-indent-1'><a href='https://ng.ant.design/docs/introduce/en' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214);'>ng-zorro</a>&nbsp;UI component:&nbsp;<code style='background-color: rgba(27, 31, 35, 0.05);'>tooltip</code>,&nbsp;<code style='background-color: rgba(27, 31, 35, 0.05);'>modal</code>,&nbsp;<code style='background-color: rgba(27, 31, 35, 0.05);'>select</code>,&nbsp;<code style='background-color: rgba(27, 31, 35, 0.05);'>icon</code> and more.</li><li class='ql-indent-1'><a href='https://github.com/KillerCodeMonkey/ngx-quill' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214);'>ngx-quill</a></li><li><a href='https://www.netlify.com/' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214);'>Netlify</a></li><li><a href='https://www.heroku.com/' rel='noopener noreferrer' target='_blank' style='color: rgb(3, 102, 214);'>Heroku</a></li></ul>",
189189
"type": "Task",
190190
"status": "Backlog",
191191
"priority": "Medium",

frontend/src/index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,24 @@
1212
Copyright 2020 Trung Vo
1313
-->
1414
<meta charset="utf-8">
15-
<title>Angular Jira Clone with Akita - by trungk18</title>
15+
<title>Angular Jira Clone with Akita and TailwindCSS - by trungk18</title>
1616
<base href="/">
1717
<meta name="viewport" content="width=device-width, initial-scale=1">
1818
<meta name="title" content="Angular Jira Clone with Akita">
19-
<meta name="description" content="A simplified Jira clone built with Angular 9 and Akita">
19+
<meta name="description" content="A simplified Jira clone built with Angular and Akita">
2020

2121
<!-- Open Graph / Facebook -->
2222
<meta property="og:type" content="website">
2323
<meta property="og:url" content="https://jira.trungk18.com/">
2424
<meta property="og:title" content="Angular Jira Clone with Akita">
25-
<meta property="og:description" content="A simplified Jira clone built with Angular 9 and Akita">
25+
<meta property="og:description" content="A simplified Jira clone built with Angular and Akita">
2626
<meta property="og:image" content="assets/img/jira-clone-tech-stack.png">
2727

2828
<!-- Twitter -->
2929
<meta property="twitter:card" content="summary_large_image">
3030
<meta property="twitter:url" content="https://jira.trungk18.com/">
3131
<meta property="twitter:title" content="Angular Jira Clone with Akita">
32-
<meta property="twitter:description" content="A simplified Jira clone built with Angular 9 and Akita">
32+
<meta property="twitter:description" content="A simplified Jira clone built with Angular and Akita">
3333
<meta property="twitter:image" content="assets/img/jira-clone-tech-stack.png">
3434
<link rel="image_src" href="assets/favicon.png" type="image/png">
3535
<link rel="shortcut icon" href="assets/favicon.png" type="image/png">

frontend/src/index.prod.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@
1111
Copyright 2020 Trung Vo
1212
-->
1313
<meta charset="utf-8">
14-
<title>Angular Jira Clone with Akita - by trungk18</title>
14+
<title>Angular Jira Clone with Akita and TailwindCSS - by trungk18</title>
1515
<base href="/">
1616
<meta name="viewport"
1717
content="width=device-width, initial-scale=1">
1818
<meta name="title"
1919
content="Angular Jira Clone with Akita">
2020
<meta name="description"
21-
content="A simplified Jira clone built with Angular 9 and Akita">
21+
content="A simplified Jira clone built with Angular and Akita">
2222

2323
<!-- Open Graph / Facebook -->
2424
<meta property="og:type"
@@ -28,7 +28,7 @@
2828
<meta property="og:title"
2929
content="Angular Jira Clone with Akita">
3030
<meta property="og:description"
31-
content="A simplified Jira clone built with Angular 9 and Akita">
31+
content="A simplified Jira clone built with Angular and Akita">
3232
<meta property="og:image"
3333
content="assets/img/jira-clone-tech-stack.png">
3434

@@ -40,7 +40,7 @@
4040
<meta property="twitter:title"
4141
content="Angular Jira Clone with Akita">
4242
<meta property="twitter:description"
43-
content="A simplified Jira clone built with Angular 9 and Akita">
43+
content="A simplified Jira clone built with Angular and Akita">
4444
<meta property="twitter:image"
4545
content="assets/img/jira-clone-tech-stack.png">
4646
<link rel="image_src"

frontend/src/stories/Introduction.stories.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This is the collection of components that I wrote for [jira.trungk18.com][jira],
2020
## What is Angular Jira Clone
2121

2222
There have been a handful of cool Jira-cloned apps written in `React`/`VueJS`, which makes me wonder **Why not Angular**? And here you go.
23-
This is not only a simplified Jira clone built with Angular 9, but also an example of a **modern**, **real-world** Angular codebase.
23+
This is not only a simplified Jira clone built with Angular, but also an example of a **modern**, **real-world** Angular codebase.
2424

2525
## Tech stack
2626

0 commit comments

Comments
 (0)