Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
prrockzed committed Dec 27, 2024
1 parent 0b7f1d0 commit aad7841
Show file tree
Hide file tree
Showing 2 changed files with 79 additions and 24 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,6 @@
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# others
ideas.txt
100 changes: 76 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,85 @@
# prrockzedFolio
<h1 align="center">prrockzedFolio</h1>

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
## 🌐 My Portfolio Website

### Installation
Welcome to the code repository for my personal portfolio website! This is where all the magic happens (or at least the organized chaos that looks like magic).

```
git clone https://github.com/prrockzed/prrockzed.github.io.git
cd prrockzed.github.io
```
The website is built using [Docusaurus](https://docusaurus.io/), the coolest static site generator in town. It's my online home, or rather we can say, this is the place where I dumped everything I got — in a curated professional way.

### Local Development
---

Install Dependencies
```
yarn install
```
## 📊 About the Website
This portfolio website is my digital doppelgänger. It's packed with:

Start the local development server
```
yarn run start
```
- **About Me**: A concise summary of who I am (no existential crises here).
- **Social Media**: Links to where I post updates, ideas, or cat memes (your call).
- **Education**: A snapshot of my academic journey, including my current stint at IIT Kharagpur.
- **Interests**: Things I’m passionate about—spoiler alert: it’s not just coding.
- **Positions of Responsibility**: My adventures in leadership within IIT Kharagpur societies.
- **Industrial Experience**: Cool stuff I’ve done in internships and projects.
- **Tech Stack**: Tools, languages, and frameworks I’ve tamed (or am still wrangling).
- **Achievements**: The brag-worthy moments that make me blush.
- **Blogs**: Where I pen down my thoughts on tech, life, and everything in between.
- **Resume**: A one-click shortcut to my professional story—your future employee of the month?

Generate the static content into a `build` directory
```
yarn run build
---

```
## 💪 Tech Stack
- **Frontend Framework**: [Docusaurus](https://docusaurus.io/) (because good-looking websites deserve it).
- **Hosting**: [Github](https://pages.github.com/) (or whatever hosting service my budget allowed).
- **Languages**: A spicy mix of JavaScript, React, and Markdown.

Start the server from the build directory
```
yarn run serve
```
---

## ⚙️ How to Run Locally
Wanna run this masterpiece locally? Here’s how(first fork it):

1. Clone the repo:
```bash
git clone https://github.com/<your-username>/portfolio-website.git
```

2. Navigate to the project directory:
```bash
cd portfolio-website
```

3. Install dependencies:
```bash
npm install
```

4. Start the development server:
```bash
npm start
```

5. Open your browser and visit `http://localhost:3000`. Voilà!

---

## 🌐 Live Demo
Check out the live version here: [My Portfolio](https://prrockzed.github.io). (This is where I hope you’ll be impressed.)

---

## 🎁 Features I’m Proud Of
- Clean, professional design (thanks to Docusaurus and my questionable design skills).
- Fully responsive (yes, it looks good even on your grandma’s old phone).
- Easy navigation (no one’s getting lost here).
- Regularly updated (well, I try).

---

## 🙏 Contributions
While this is my personal portfolio, I’m open to suggestions and feedback. If you spot a typo, find a bug, or just want to say hi, feel free to open an issue, submit a pull request or start a discussion.

---

## 📢 A Final Note
This website is the labor I have done in my whole life(well not technically). If you like what you see, feel free to star this repo — it’ll make my day!

Thanks for stopping by!

Cheers,
*Priyanshu Ranjan*

0 comments on commit aad7841

Please sign in to comment.