From c40a45f2d649f9a0dda5d8a02b96efa500335520 Mon Sep 17 00:00:00 2001 From: Zakary Timson Date: Wed, 6 Dec 2023 19:29:55 +0000 Subject: [PATCH] Update README.md --- README.md | 151 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 83 insertions(+), 68 deletions(-) diff --git a/README.md b/README.md index c7b04a6..0b04669 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,83 @@ - -
-
- - - Logo - - -### ETF Demo - - -Recruitement project for Enjine - -
- -## Table of Contents -- [ETF Demo](#top) - - [About](#about) - - [Built With](#built-with) - - [Demo](#demo) - - [Setup](#setup) - - [Development](#development) - - [License](#license) - -## About -While applying for a contract with Enjine, I was paid to create a sample program for comparing Electronically Traded Funds (ETF) files. - -Using Angular, a user can upload two different CSV files & compare the differences using graphs. - -This project was deployed using Firebase. - -### Built With -[![Angular](https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular)](https://angular.io/) -[![Firebase](https://img.shields.io/badge/Firebase-FFFFFF?style=for-the-badge&logo=firebase)](https://firebase.google.com/) -[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/) - -## Demo - -Website: TBD - -Demo CSV Files: - - [data/Holding_details_FTSE_Canada_All_Cap_Index_ETF_(VCN).csv](./data/Holding_details_FTSE_Canada_All_Cap_Index_ETF_(VCN).csv) - - [data/Holding_details_FTSE_Canada_Index_ETF_(VCE).csv](./data/Holding_details_FTSE_Canada_Index_ETF_(VCE).csv) - - [data/Holding_details_FTSE_Canadian_Capped_REIT_Index_ETF_(VRE).csv](./data/Holding_details_FTSE_Canadian_Capped_REIT_Index_ETF_(VRE).csv) - -## Setup - -
- -

- Development -

-
- -#### Prerequisites -- [Node.js](https://nodejs.org/en/download) - -#### Instructions -1. Install the dependencies: `npm install` -2. Start the Angular server: `npm run start` -3. Open [http://localhost:4200](http://localhost:4200) - -
- -## License -Copyright © 2023 Zakary Timson | All Rights Reserved - -See the [license](./LICENSE) for more information. + +
+
+ + + Logo + + + ### ETF Demo + + + Recruitement project for Enjine + + + [![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/etf-demo/tags&query=$[0].name)](https://git.zakscode.com/ztimson/etf-demo/tags) + [![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/etf-demo&query=open_pr_counter)](https://git.zakscode.com/ztimson/etf-demo/pulls) + [![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/etf-demo&query=open_issues_count)](https://git.zakscode.com/ztimson/etf-demo/issues) + + + + --- +
+ Release Notes + • Report a Bug + • Request a Feature +
+ + --- +
+ +## Table of Contents +- [ETF Demo](#top) + - [About](#about) + - [Demo](#demo) + - [Built With](#built-with) + - [Setup](#setup) + - [Development](#development) + - [License](#license) + +## About +While applying for a contract with Enjine, I was paid to create a sample program for comparing Electronically Traded Funds (ETF) files. + +Using Angular, a user can upload two different CSV files & compare the differences using graphs. + +This project was deployed using Firebase. + +### Demo + +Website: TBD + +Demo CSV Files: + - [data/Holding_details_FTSE_Canada_All_Cap_Index_ETF_(VCN).csv](./data/Holding_details_FTSE_Canada_All_Cap_Index_ETF_(VCN).csv) + - [data/Holding_details_FTSE_Canada_Index_ETF_(VCE).csv](./data/Holding_details_FTSE_Canada_Index_ETF_(VCE).csv) + - [data/Holding_details_FTSE_Canadian_Capped_REIT_Index_ETF_(VRE).csv](./data/Holding_details_FTSE_Canadian_Capped_REIT_Index_ETF_(VRE).csv) + +### Built With +[![Angular](https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular)](https://angular.io/) +[![Firebase](https://img.shields.io/badge/Firebase-FFFFFF?style=for-the-badge&logo=firebase)](https://firebase.google.com/) +[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/) + +## Setup + +
+ +

+ Development +

+
+ +#### Prerequisites +- [Node.js](https://nodejs.org/en/download) + +#### Instructions +1. Install the dependencies: `npm install` +2. Start the Angular server: `npm run start` +3. Open [http://localhost:4200](http://localhost:4200) + +
+ +## License +Copyright © 2023 Zakary Timson | All Rights Reserved + +See the [license](./LICENSE) for more information.