Skip to content

Commit 82c8851

Browse files
committed
📝 README updated
1 parent 93ceb1b commit 82c8851

File tree

8 files changed

+80
-25
lines changed

8 files changed

+80
-25
lines changed

README.md

Lines changed: 63 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,76 @@
1-
# Frontend
1+
# InfoReader Frontend
22

3-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 13.2.2.
3+
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 13.2.2
44

5-
## Development server
5+
## Get started
66

7-
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
7+
### Requirements
88

9-
## Code scaffolding
9+
- [Visual Studio Code](https://code.visualstudio.com/)
10+
- [Git](https://git-scm.com/downloads)
11+
- [NodeJs](https://nodejs.org/en/)
12+
- [Angular CLI](https://angular.io/cli)
1013

11-
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
14+
### Clone the repo
1215

13-
## Build
16+
```shell
17+
git clone https://github.com/marcode24/InfoReader-Frontend
18+
cd InfoReader-Frontend
19+
```
1420

15-
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
21+
### Install npm packages
1622

17-
## Running unit tests
23+
Install the `npm` packages described in the `package.json` and verify that it works.
1824

19-
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
25+
```shell
26+
npm install
27+
ng serve -o
28+
```
2029

21-
## Running end-to-end tests
30+
Shut it down manually with `Ctrl+C`
2231

23-
Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
32+
## Environments
2433

25-
## Further help
34+
| Name | URL | PORT |
35+
| ---------- | ---------------------------------------- | ---- |
36+
| Localhost | [localhost](http://localhost:4200) | 4200 |
37+
| Production | [www.domain.com](https://www.domain.com) |
2638

27-
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
39+
## Folder Structure
40+
41+
.
42+
├── src
43+
│ ├── app # Source code application
44+
│ │ │── auth # Module for auth feature
45+
│ │ ├── core # Module as a singleton
46+
│ │ │ ├── components
47+
│ │ │ ├── constants
48+
│ │ │ ├── guards
49+
│ │ │ ├── interfaces
50+
│ │ │ ├── models
51+
│ │ │ ├── pipes
52+
│ │ │ ├── services
53+
│ │ │ └── utils
54+
│ │ ├── features # Module for features which compose the application
55+
│ │ ├── shared # Module for components shared between application modules
56+
│ │ │ ├── components
57+
│ ├── assets # Styles, images, icons, fonts etc
58+
│ ├── environments # Config by environment (localhost and production)
59+
│ └── styles # Global styles
60+
└── README.md
61+
62+
## Previews
63+
64+
### Desktop
65+
66+
![home-1](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346332/InfoReader/home-1_gpqyqq.png)
67+
![home-2](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346331/InfoReader/home-2_hpojr8.png)
68+
![home-3](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346331/InfoReader/home-4_vqxco3.png)
69+
![home-4](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346331/InfoReader/home-3_qqeh64.png)
70+
71+
### Mobile
72+
73+
![mobile-1](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346331/InfoReader/mobile-1_wjz51l.png)
74+
![mobile-2](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346331/InfoReader/mobile-2_d7umlp.png)
75+
![mobile-3](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346332/InfoReader/mobile-4_dbtnph.png)
76+
![mobile-4](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346331/InfoReader/mobile-3_r1ppv3.png)

src/app/app.component.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ import { SettingService } from '@services/setting.service';
77
styleUrls: ['./app.component.css']
88
})
99
export class AppComponent {
10-
title = 'frontend';
1110
constructor(
1211
private settingService: SettingService,
1312
) {

src/app/core/components/sidebar/sidebar.component.css

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,18 @@ nav .logo-details {
2020
align-items: center;
2121
position: relative;
2222
opacity: 1;
23+
gap: 5px;
2324
}
2425

25-
nav .logo-details .icon {
26+
nav .logo-details img {
2627
opacity: 1;
2728
transition: 0.5s;
28-
color: var(--primary-color);
29+
max-width: 3.2rem;
2930
}
3031

3132
nav .logo-details span.logo_name {
3233
color: var(--primary-color);
33-
font-size: 20px;
34+
font-size: 30px;
3435
font-weight: 600;
3536
opacity: 1;
3637
transition: 0.5s;
@@ -220,6 +221,11 @@ nav .profile {
220221
display: block;
221222
}
222223

224+
nav .logo-details {
225+
gap: 0;
226+
justify-content: center;
227+
}
228+
223229
nav .logo-details .logo_name,
224230
nav li a .links_name,
225231
.profile-details .username,

src/app/core/components/sidebar/sidebar.component.html

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<nav class="sidebar">
22
<div class="logo-details">
3-
<i class='bx bx-news icon'></i>
3+
<img src="/assets/logo.png" alt="logo" srcset="">
4+
<!-- <i class='bx bx-news icon'></i> -->
45
<span class="logo_name">InfoReader</span>
56
</div>
67
<ul class="nav-list">
@@ -41,9 +42,7 @@
4142
</div>
4243
<div *ngIf="isAuthenticated" routerLink="/settings" class="profile-details">
4344
<figure class="box-image">
44-
<img
45-
src="https://images.unsplash.com/photo-1487412720507-e7ab37603c6f?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1171&q=80"
46-
alt="img-user">
45+
<img src="https://res.cloudinary.com/dfeujtobk/image/upload/v1598123661/user_xzklt6.png" alt="img-user">
4746
</figure>
4847
<span class="username"> {{ getName }} </span>
4948
</div>

src/assets/book.ico

203 KB
Binary file not shown.

src/assets/logo.png

91.5 KB
Loading

src/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33

44
<head>
55
<meta charset="utf-8">
6-
<title>Frontend</title>
6+
<title>InfoReader</title>
77
<base href="/">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<link href='https://unpkg.com/[email protected]/css/boxicons.min.css' rel='stylesheet'>
10-
<link rel="icon" type="image/x-icon" href="favicon.ico">
10+
<link rel="icon" type="image/x-icon" href="./assets/book.ico">
1111
</head>
1212

1313
<body>

src/styles.css

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ body.dark {
3333
--bg-skeleton: #424449;
3434
--bg-skeleton-2: #2e2c2c;
3535
--text-shadow-color: #000000;
36+
--bg-blur: hsla(0, 0%, 10%, 0.6);
3637
}
3738

3839
:root {
@@ -51,6 +52,7 @@ body.dark {
5152
--bg-skeleton: #fafafa;
5253
--bg-skeleton-2: #cdcdcd;
5354
--text-shadow-color: #e6e6e6;
55+
--bg-blur: hsla(0, 0%, 100%, 0.8);
5456
}
5557

5658
::-webkit-scrollbar {
@@ -235,7 +237,7 @@ section > .title-wrapper {
235237
display: flex;
236238
align-items: center;
237239
justify-content: space-between;
238-
background: hsla(0, 0%, 100%, 0.6);
240+
background: var(--bg-blur);
239241
}
240242

241243
.title-wrapper > span.title-section {

0 commit comments

Comments
 (0)