Skip to content

Commit

Permalink
Merge pull request #8 from yqni13/development
Browse files Browse the repository at this point in the history
Development_v1.0.0
  • Loading branch information
yqni13 authored Jun 5, 2024
2 parents 95b14c5 + 6ee6c10 commit d32a3ba
Show file tree
Hide file tree
Showing 66 changed files with 3,839 additions and 63 deletions.
74 changes: 62 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,77 @@
# Portfolio
# yqni13 portfolio
$\texttt{\color{teal}{v1.0.0}}$

<div>
<img src="./src/assets/readme_img/readme_responsive_demonstration.png">
</div>

### Technology

<div style="display:flex; align-items:center;">
<img src="https://img.shields.io/badge/Angular-%23DD0031.svg?logo=angular&logoColor=white">
<img alt="Google Fonts" src="https://external-content.duckduckgo.com/iu/?u=https%3A%2F%2Flogos-world.net%2Fwp-content%2Fuploads%2F2021%2F03%2FGoogle-Fonts-Logo.png&f=1&nofb=1&ipt=570b1eadbf10850285149faa90b47496e415ec5daf70efb973248c194025a6a5&ipo=images" style="height:auto; width:5%">Google Fonts
</div>
<br><br>

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

## Development server

Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
Get startet with `npm install` and to start run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
<br><br>

## Features
<dl>
<dd>:iphone: Responsive design 480px > width < 1440px via flexbox and media queries</dd>
<dd>:book: Multi-Page Layout (main navigation and portfolio menu)</dd>
<dd>:new_moon_with_face:/:sun_with_face: Dark/Light mode</dd>
<dd>:art: Customized style</dd>
</dl>

## Portfolio

## Code scaffolding
The portfolio component splits up to different $\textsf{\color{limegreen}{menu options}}$. The overview "all" displays all projects regarding my work as a frontend-developer. Additionally I split the projects to different types like "frontend"-only, "fullstack" and smaller "modules".
<br>

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`.
<div align="center">
<img src="./src/assets/readme_img/readme_portfolio_menu.png">
</div>
<br><br>

## Build
Every project is displayed in card-style, containing a screenshot of the project user-interface and on hovering more information appear. The title, keywords, version and used technology icons will give a quick overview. Additionally, every project-card has a $\textsf{\color{red}{direct link}}$ to the regarding repository $\textsf{\color{red}{via github icon}}$ to open in a new tab.

Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
<div align="center">
<img src="./src/assets/readme_img/readme_portfolio_card_normal.png">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<img src="./src/assets/readme_img/readme_portfolio_card_hover.png">
</div>
<br><br>

## Running unit tests
## Theme settings

Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
My portfolio comes with two theme settings: $\textsf{\color{gray}{Dark mode}}$ & $\textsf{\color{goldenrod}{Light mode}}$. The button to change the theme sits in the nav bar after the last menu option. If dark mode is enabled, the moon symbol is displayed or the sun for the enabled light mode. The local storage saves the setting, so navigating to another webpage and coming back later will still display the user-interface in the previously set theme (default setting: Dark mode).
<br>

## Running end-to-end tests
<div align="center">
<img src="./src/assets/readme_img/readme_dark_mode.png">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<img src="./src/assets/readme_img/readme_light_mode.png">
</div>

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.
## Updates

## Further help
### Aimed objectives for next $\textsf{\color{green}minor}$ update:
<dl>
<dd>- changing portfolio cards from description text to keywords</dd>
<dd>- error handling for images failing to load</dd>
<dd>- improve data binding</dd>
<dd>- create portfolio cards in html via *ngFor</dd>
</dl>
<br>

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.
### Aimed objectives for next $\textsf{\color{cyan}major}$ update:
<dl>
<dd>- translation option to switch between german/english</dd>
<dd>- responsive design > 1440px width</dd>
<dd>- customized error page</dd>
</dl>
14 changes: 8 additions & 6 deletions angular.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@
"styles": [
"src/styles.scss",
"src/stylesheets/colors.scss",
"src/stylesheets/media.scss"
"src/stylesheets/media.scss",
"src/stylesheets/icons.scss"
],
"scripts": []
},
Expand All @@ -48,13 +49,13 @@
"budgets": [
{
"type": "initial",
"maximumWarning": "500kb",
"maximumError": "1mb"
"maximumWarning": "4mb",
"maximumError": "5mb"
},
{
"type": "anyComponentStyle",
"maximumWarning": "2kb",
"maximumError": "4kb"
"maximumWarning": "150kb",
"maximumError": "150kb"
}
],
"outputHashing": "all"
Expand Down Expand Up @@ -101,7 +102,8 @@
"styles": [
"src/styles.scss",
"src/stylesheets/colors.scss",
"src/stylesheets/media.scss"
"src/stylesheets/media.scss",
"src/stylesheets/icons.scss"
],
"scripts": []
}
Expand Down
2 changes: 1 addition & 1 deletion desktop.ini
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[.ShellClassInfo]
IconResource=D:\Dokumente\GitHub\Private_Projects\portfolio\src\assets\img\folder.ico,0
IconResource=D:\Dokumente\GitHub\Private_Projects\yqni13\src\assets\img\folder.ico,0
[ViewState]
Mode=
Vid=
Expand Down
Loading

0 comments on commit d32a3ba

Please sign in to comment.