Personal Portfolio

Table of contents

• Description
• IDE - Tools - Environment
• Angular Concepts
• How to run the application
• Issues
• References
• Licence

Description

Personal portfolio developed using Angular framework, a well-known JavaScript framework for building Single-Page Applications(SPA), and other web technologies such as HTML5, SCSS, and Bootstrap.

Back to top

IDE - Tools - Environment

• Operating System - Windows 11 x64
• Angular CLI - v19.2.7
• Visual Studio Code
• Node.js - v20.11.1
• GitHub & Git Bash
• Angular DevTool
• Postman

Back to top

Project Concepts

• Responsive UI Design ( HTML5 | SCSS | Grid & Flexbox Layouts | Bootstrap).
• Angular/Typescript framework
  • Module-Based Approach (not stand-alone components).
• APIs Integration
  • Real-time Weather (GeoLoction-based)
  • MailJs API
  • Social Share Buttons
• Features:
  • Themes Toggle (Dark vs Light)
  • Contact Form (email integrated)
  • Social Share Buttons (Open Graphs | Meta Interface)
• SEO (Angular Universal | Title Interface | Meta Interface)
• Performance Optimization (Lazy loading | SSR | Image Opimization)

Back to top

How to run the application

1. Installation

Ensure that you have following items are installed in your computer:

• Visual Studio Code
• Node.js
• Angular CLI

2. Clone GitHub repository

Clone the project prj-portfolio from Github repository into your local repository . For more information about how to clone the GitHub repository, see Cloning GitHub repository.

3. Update the API Keys

Ensure that your in possession of MailJs API Key. Open index.html in the source directory of the project and replace YOUR_API_KEY with your MailJs API Key.

 <script async src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&loading=async&callback=Function.prototype&v=weekly"></script>

4. Start the Localhost server

Run the following command in your CLI to install all the rrequired packages:

npm install

Run the following command in your CLI to start the localhost server.

ng serve

Once the localhost server is running, navigate to http://localhost:4200/ or copy/paste http://localhost:4200/ in your browser address-bar, then press enter.

Back to top

Issues

• The application uses Google Maps services which requires the APK Key. This means that you will to have a Google Maps API Key for Google Maps to launch.
• Unit Testing has not been implemented yet.

Back to top

References

• For more information related to Angular setup, please check out the Angular documentation page.
• For more information related to Angular CLI, please check out the Angular CLI Overview and Command Reference page.
• For more information related to Node.js, please check out the Introduction to Node.js page.
• For more information related to Node Package Manager (NPM), please check out the npm Docs page.

Back to top

Licence

MIT License

Copyright (c) 2024 | Yingisani

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE..

Back to top