Skip to content

Commit

Permalink
docs: readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
JohannThapa committed Aug 25, 2024
1 parent c748483 commit 3a4abd0
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
28 changes: 24 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# TMR Portfolio
# TMR - Tech Maven & Revamp

Dynamic Angular user portfolio with real-time weather and crypto data. Built with Tailwind CSS & chart.js for speed and style.

![version](https://img.shields.io/badge/version-0.2.beta-blue.svg) ![license](https://img.shields.io/badge/license-MIT-blue.svg)![Angular](https://img.shields.io/badge/angular-18.1.4-red) ![Tailwind](https://img.shields.io/badge/tailwind-latest-blue) ![GraphQL](https://img.shields.io/badge/graphQL-16-blue')
<a href="https://www.linkedin.com/in/rupak-thapa-magar-703468296/" target="_blank">![Chat](https://img.shields.io/badge/chat-on%20linkedin-7289da.svg)</a>

![Index Page]()

## Installation

Install `pnpm` sing `npm`
Expand All @@ -24,10 +29,20 @@ run application
ng serve
```

## Tech Stack
### Pages

**Client:** Angular, TailwindCSS, Apache
Here are all the page from the project:
- [Dashboard](https://tmr-amber.vercel.app/dashboard/index)
- Dashboard Pages
- [Index](https://demos.creative-tim.com/notus-angular/admin/dashboard?ref=na-github-readme)
- [Crypto](https://tmr-amber.vercel.app/dashboard/crypto)
- Components Pages
- [Table](https://tmr-amber.vercel.app/components/table)
- [Address & Weather](https://tmr-amber.vercel.app/components/weather)

## Tech Stack

**Client:** Angular, TailwindCSS, Apache, GraphQL, chart.js

## Features

Expand Down Expand Up @@ -58,7 +73,6 @@ To run prettier, run the following command

[MIT](https://choosealicense.com/licenses/mit/)


## Screenshots

#### Features
Expand Down Expand Up @@ -86,3 +100,9 @@ To run prettier, run the following command
| `npm run prettier:verify` | Runs prettier-check and throws error if fails |
| `npm run prettier:staged` | Runs prettier on only staged (changed) files |
| `npm run e2e-ui` | Runs playwright e2e test with UI |

## Acknowledgements

- [SVG Images](https://undraw.co/)
- [Hero Icons](https://heroicons.com/)

Binary file added src/assets/gif/intro.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3a4abd0

Please sign in to comment.