diff --git a/README.md b/README.md index 7acb190..6214d04 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,94 @@ -# My [Portfolio](https://carsonsgit.github.io/) +
+

carsonSgit's Portfolio

+ + LinkedIn + + + GitHub + + + Email + +

+ +
-Welcome to the repo for my portfolio! +
+

💻 Tech Stack

+
+ React + TypeScript + SCSS +
+
-> [!IMPORTANT] -> This is still currently a W.I.P! primarily because of mobile responsiveness and procrastination..... ALMOST DONE! +

📔 About

- +🌟 **Welcome to my portfolio!** My site showcases my journey as a Computer Scientist, showing my skills, projects, experiences, and achievements. -> Site Preview +

✨ Features

-## Technologies Used +- 🎨 **Top Project Showcase:** Tiled sections featuring my top projects with links to live demos and GitHub repos. +- 🔧 **Technologies:** A display of *most* of the technologies I've used in my CS career. +- 📱 **Responsive Design:** Made with different screen-sizes in mind (mobile-first approach). -- `React` -- `TypeScript` -- `SCSS` -## Important Links +

🔗 Important Links

-- Resources for development: [Helpful Links](https://github.com/carsonSgit/carsonsgit.github.io/issues/9) -- Commit/Merge prefixes: [Commit Message Prefixes](https://github.com/carsonSgit/carsonsgit.github.io/issues/14) +- 📚 **Development Resources:** Here are some [helpful links](https://github.com/carsonSgit/carsonsgit.github.io/issues/9) I made use of during development. +- 🔍 **Commit/Merge Prefixes:** I used these [commit message prefixes](https://github.com/carsonSgit/carsonsgit.github.io/issues/14) to improve my Git habits. +- 📖 **React Documentation:** Learn more about React [here](https://reactjs.org/docs/getting-started.html). +- 📘 **TypeScript Documentation:** Explore TypeScript documentation [here](https://www.typescriptlang.org/docs/). +- 🎨 **SCSS Documentation:** Check out the SCSS documentation [here](https://sass-lang.com/documentation). + + +

📈 Quick Repo Stats

+ +
+

+ GitHub Stars + GitHub Closed Issues + GitHub PRs +

+

+ GitHub Code Size + GitHub Repo Size + GitHub Languages +

+
+ +

🚀 Deploy Locally

+If you want to run it locally follow these steps: + +### 🔧 Prerequisites: +- `Git` +- `Node.js` +- `npm (Node Package Manager)` + +### 📥 Installation Steps: +1. Clone the repository: + ```bash + git clone https://github.com/carsonSgit/carsonsgit.github.io.git + ``` +2. Go to the project directory: + ```bash + cd carsonsgit.github.io + ``` +3. Install dependencies + ```bash + npm i + ``` + **OR** if your `npm i` doesn't work + + ```bash + npm i --force + ``` +4. Run locally + ```bash + npm start + ``` +5. Open your browser at `http://localhost:3000`! + +
+ +**Thank you for visiting my portfolio! 🎉**