Skip to content

Commit b3b2f3d

Browse files
authored
Merge pull request trungvose#45 from trungk18/rc1-preparation
Bump version to 1.0.0.alpha1
2 parents c2d39cc + df6bc3d commit b3b2f3d

File tree

8 files changed

+58
-18
lines changed

8 files changed

+58
-18
lines changed

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ I have been working with Angular for about four years. I built cool stuff at [Zy
2727

2828
This is a showcase application I've built in my spare time to experiment the new library that I wanted to try before: `Akita`, `TailwindCSS`, `ng-zorro`.
2929

30-
There are many Angular examples on the web but most of them are way too simple. I like to think that this codebase contains enough complexity to offer valuable insights to Angular developers of all skill levels while still being _relatively_ easy to understand.
30+
There are many Angular examples on the web but most of them are way too simple. I like to think that this codebase contains enough complexity to offer valuable insights to **Angular developers of all skill levels** while still being _relatively_ easy to understand.
3131

3232
---
3333

34-
This piece of work is part of our technical series [angular-vietnam/100-days-of-angular][100days] which aims at enabling everyone, after 100 days of learning Angular with us, to **self-build their application with the similar scale**. Our desire is to advocate and grow the Angular developer community in Vietnam.
34+
This piece of work is also part of our technical series [angular-vietnam/100-days-of-angular][100days] which aims at enabling everyone, after 100 days of learning Angular with us, to **self-build their application with the similar scale**. Our desire is to advocate and grow the Angular developer community in Vietnam.
3535

3636
[zyllem]: https://www.zyllem.com/
3737

@@ -84,26 +84,30 @@ While working with this application, I have the opportunity to revisit some of t
8484
- Scrollable layout with Flexbox
8585
- Deploy Angular application to Netlify
8686

87-
I will take two weeks break to continue working with the [typescript-data-structures][typescript-dsa] repo.
87+
I will take two weeks break to:
88+
89+
- Fix bugs and UI enhancements for Angular Jira clone.
90+
- Continue working with the [typescript-data-structures][typescript-dsa] repo.
8891

8992
[typescript-dsa]: https://github.com/trungk18/typescript-data-structures
9093

9194
### Phase 2
9295

9396
> July 10 - 25, 2020
9497
98+
- [ ] Refactor the mono repo to use Nx Workspace
9599
- [ ] GraphQL API and store data on the actual database
96100
- [ ] Authentication
97101
- [ ] Websocket realtime update
98102
- [ ] Interactive report
99103

100104
## Tutorial
101105

102-
When I look at the application, it is huge. When the task is huge, you don't know where and how to start working with them. I started to break the big task into a [simple to-do list on notion][todo-list]. Once I know what needs to be done, what I need is to follow the plan. That's is my approach.
106+
When I look at the application, it is huge. When the task is huge, you usually don't know where and how to start working with them. I started to break the big task into a [simple to-do list on notion][todo-list]. Once I know what needs to be done, what I need is to follow the plan. That's is my approach.
103107

104108
I learned a lot of stuff. I know you might also have a curiosity about the process of building the same scale app as well. That's why I am writing a tutorial series on how I built Angular Jira clone from scratch. I hope you guys will learn something from that too :)
105109

106-
Please bear with me for a little longer. Because with almost 50 hours coding, to write every single step is impossible. But hopefully through the tutorial, you will get the idea and can start building your idea very soon.
110+
I will try to be as detailed as possible. Hopefully through the tutorial, you will get the idea and will start working on your own application soon. Please bear with me.
107111

108112
Its series will also be published in Vietnamese as part of our [angular-vietnam/100-days-of-angular][100days].
109113

@@ -127,11 +131,11 @@ Its series will also be published in Vietnamese as part of our [angular-vietnam/
127131

128132
## Time spending
129133

130-
I built it as the side project so It usually took longer than expected. One day, my team and I were fire fighting on PROD until 11 PM. After taking a shower, I continue with Angular Jira clone for another two hours...
134+
It is a side project that I only spent time outside of the office hours to work on. One day, my team and I were fire fighting on PROD until 11 PM. After taking a shower, I continue with Angular Jira clone for another two hours...
131135

132136
According to waka time report, I have spent about 45 hours working on this project. Which is equivalent to watch the [whole Stranger Things series twice][stranger].
133137

134-
I enjoyed working on this project. The interactive kanban board took me sometimes, it is challenging but exciting at the same time.
138+
I really enjoyed working on this project. The interactive kanban board took me sometimes, it is challenging but exciting at the same time.
135139

136140
[stranger]: [https://www.bingeclock.com/s/stranger-things/]
137141

@@ -147,7 +151,7 @@ I built a very simple NestJS API to send a fixed data structure to the client. A
147151

148152
### Proper authentication system 🔐
149153

150-
I am currently sending a fixed email and a random password to the server to get the current user back. Phase 2 will also bring a proper authentication system.
154+
I am currently sending the same email and a random password to the server without any check to get the current user back. Phase 2 will also bring a proper authentication system.
151155

152156
### Accessibility ♿
153157

@@ -157,15 +161,19 @@ Not all components have properly defined [aria attributes](https://developer.moz
157161

158162
- `git clone https://github.com/trungk18/jira-clone-angular.git`
159163
- `cd jira-clone-angular`
160-
- `npm run install-dependencies`
161164
- `npm run start:back` for the API
165+
- The API server should run on `http://localhost:3000`
162166
- `npm run start:front` for angular web application
163-
- App should now be running on `http://localhost:4200/`
167+
- The app should run on `http://localhost:4200/`
164168

165169
### Unit/Integration tests 🧪
166170

167171
I skipped writing test for this project. I might do it for the proper backend GraphQL API.
168172

173+
## Compatibility
174+
175+
It was being tested on IE 11, Chrome and Firefox. For Safari, there are some minor alignment issues.
176+
169177
## Author: Trung Vo ✍️
170178

171179
- A young and passionate front-end engineer. Working with Angular and TypeScript. Like photography, running, cooking, and reading books.
@@ -180,7 +188,9 @@ If you'd like to contribute, please fork the repository and make changes as you'
180188

181189
## Credits
182190

183-
Inspired by [oldboyxx/jira_clone][oldboyxx] and [Datlyfe/jira_clone][datlyfe]
191+
Inspired by [oldboyxx/jira_clone][oldboyxx] and [Datlyfe/jira_clone][datlyfe].
192+
193+
I reused part of the HTML and CSS code from these projects.
184194

185195
## License
186196

backend/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name": "backend",
3-
"version": "0.0.1",
2+
"name": "jira-clone-angular-backend",
3+
"version": "1.0.0.alpha1",
44
"description": "",
55
"author": "",
66
"private": true,

backend/src/main.ts

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
/*
2+
* Project: Angular Jira clone
3+
* Author: Trung Vo ([email protected])
4+
* Homepage: https://github.com/trungk18/jira-clone-angular
5+
* -----
6+
* Last Modified: Monday, 29th June 2020 9:43:45 am
7+
* Modified By: Trung Vo ([email protected]>)
8+
* -----
9+
* Copyright 2020 Trung Vo
10+
*/
11+
112
import { NestFactory } from '@nestjs/core';
213
import { AppModule } from './app.module';
314
import { CorsOptions } from '@nestjs/common/interfaces/external/cors-options.interface';
@@ -7,7 +18,7 @@ const corsOptions: CorsOptions = {
718
};
819
async function bootstrap() {
920
const app = await NestFactory.create(AppModule, {
10-
cors: corsOptions
21+
cors: corsOptions,
1122
});
1223
await app.listen(process.env.PORT || 3000);
1324
}

frontend/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "jira-clone-angular-frontend",
3-
"version": "0.0.1",
3+
"version": "1.0.0.alpha1",
44
"scripts": {
55
"ng": "ng",
66
"start": "ng serve",

frontend/src/app/project/config/editor.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ export const quillConfiguration = {
55
[{ list: 'ordered' }, { list: 'bullet' }],
66
[{ header: [1, 2, 3, 4, 5, 6, false] }],
77
[{ color: [] }, { background: [] }],
8+
['link'],
89
['clean']
910
]
1011
};

frontend/src/index.html

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
<!doctype html>
22
<html lang="en">
33
<head>
4+
<!--
5+
Project: Angular Jira clone
6+
Author: Trung Vo ([email protected])
7+
Homepage: https://github.com/trungk18/jira-clone-angular
8+
-----
9+
Last Modified: Monday, 29th June 2020 9:41:59 am
10+
Modified By: Trung Vo ([email protected]>)
11+
-----
12+
Copyright 2020 Trung Vo
13+
-->
414
<meta charset="utf-8">
515
<title>Angular Jira Clone with Akita - by trungk18</title>
616
<base href="/">

frontend/src/index.prod.html

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
<!doctype html>
22
<html lang="en">
3-
4-
<head>
3+
<!--
4+
Project: Angular Jira clone
5+
Author: Trung Vo ([email protected])
6+
Homepage: https://github.com/trungk18/jira-clone-angular
7+
-----
8+
Last Modified: Monday, 29th June 2020 9:41:59 am
9+
Modified By: Trung Vo ([email protected]>)
10+
-----
11+
Copyright 2020 Trung Vo
12+
-->
513
<meta charset="utf-8">
614
<title>Angular Jira Clone with Akita - by trungk18</title>
715
<base href="/">

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "jira-clone-angular",
3-
"version": "0.0.1",
3+
"version": "1.0.0.alpha1",
44
"description": "A simplified Jira clone built with Angular 9 and Akita",
55
"scripts": {
66
"install-dependencies": "npm run install-dependencies-front && npm run install-dependencies-back",

0 commit comments

Comments
 (0)