Skip to content

Commit 226751b

Browse files
authored
Merge pull request #105 from carsonSgit/readme
feat: Finalize README
2 parents 7d68203 + 16c2caa commit 226751b

File tree

1 file changed

+86
-13
lines changed

1 file changed

+86
-13
lines changed

README.md

Lines changed: 86 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,94 @@
1-
# My [Portfolio](https://carsonsgit.github.io/)
1+
<div align="center">
2+
<h1><strong>carsonSgit's Portfolio</strong></h1>
3+
<a href="https://www.linkedin.com/in/carsonspriggs">
4+
<img src="https://img.shields.io/badge/-LinkedIn-0077B5.svg?style=for-the-badge&logo=linkedin&logoColor=white" alt="LinkedIn" />
5+
</a>
6+
<a href="https://github.com/carsonSgit">
7+
<img src="https://img.shields.io/badge/-GitHub-181717.svg?style=for-the-badge&logo=github&logoColor=white" alt="GitHub" />
8+
</a>
9+
<a href="mailto:carsonspriggs8@gmail.com">
10+
<img src="https://img.shields.io/badge/-Email-D14836.svg?style=for-the-badge&logo=gmail&logoColor=white" alt="Email" />
11+
</a>
12+
<br /><br />
13+
<img src="https://github.com/user-attachments/assets/78b42bd7-1abb-4dd5-9480-351413ee0217" width="700" />
14+
</div>
215

3-
Welcome to the repo for my portfolio!
16+
<div align="center">
17+
<h2>💻 Tech Stack</h2>
18+
<div style="display: flex; gap: 20px; justify-content: center;">
19+
<img src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTSoW3g9hjXIasgon-kpzz-lD9z4SsalyPbZA&s" alt="React" width="50" height="50" />
20+
<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/typescript/typescript-original.svg" alt="TypeScript" width="50" height="50" />
21+
<img src="https://github.com/user-attachments/assets/1259cb2a-6c04-4597-bda6-511a2990ccc8" alt="SCSS" width="50" height="50" />
22+
</div>
23+
</div>
424

5-
> [!IMPORTANT]
6-
> This is still currently a W.I.P! primarily because of mobile responsiveness and procrastination..... ALMOST DONE!
25+
<div align="center"><h2> 📔 About </h2></div>
726

8-
<img src="https://github.com/user-attachments/assets/d38451ae-dc70-4290-af6d-c597b94f99e5" width="500"/>
27+
🌟 **Welcome to my portfolio!** My site showcases my journey as a Computer Scientist, showing my skills, projects, experiences, and achievements.
928

10-
> Site Preview
29+
<div align="center"><h2> ✨ Features </h2></div>
1130

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

14-
- `React`
15-
- `TypeScript`
16-
- `SCSS`
1735

18-
## Important Links
36+
<div align="center"><h2> 🔗 Important Links </h2></div>
1937

20-
- Resources for development: [Helpful Links](https://github.com/carsonSgit/carsonsgit.github.io/issues/9)
21-
- Commit/Merge prefixes: [Commit Message Prefixes](https://github.com/carsonSgit/carsonsgit.github.io/issues/14)
38+
- 📚 **Development Resources:** Here are some [helpful links](https://github.com/carsonSgit/carsonsgit.github.io/issues/9) I made use of during development.
39+
- 🔍 **Commit/Merge Prefixes:** I used these [commit message prefixes](https://github.com/carsonSgit/carsonsgit.github.io/issues/14) to improve my Git habits.
40+
- 📖 **React Documentation:** Learn more about React [here](https://reactjs.org/docs/getting-started.html).
41+
- 📘 **TypeScript Documentation:** Explore TypeScript documentation [here](https://www.typescriptlang.org/docs/).
42+
- 🎨 **SCSS Documentation:** Check out the SCSS documentation [here](https://sass-lang.com/documentation).
43+
44+
45+
<div align="center"><h2> 📈 Quick Repo Stats </h2></div>
46+
47+
<div align="center">
48+
<p>
49+
<img src="https://img.shields.io/github/stars/carsonSgit/carsonsgit.github.io?style=for-the-badge" alt="GitHub Stars" />
50+
<img src="https://img.shields.io/github/issues-closed/carsonSgit/carsonsgit.github.io?style=for-the-badge" alt="GitHub Closed Issues" />
51+
<img src="https://img.shields.io/github/issues-pr-closed/carsonSgit/carsonSgit.github.io?style=for-the-badge" alt="GitHub PRs" />
52+
</p>
53+
<p>
54+
<img src="https://img.shields.io/github/languages/code-size/carsonSgit/carsonSgit.github.io?style=for-the-badge" alt="GitHub Code Size" />
55+
<img src="https://img.shields.io/github/repo-size/carsonSgit/carsonSgit.github.io?style=for-the-badge" alt="GitHub Repo Size" />
56+
<img src="https://img.shields.io/github/languages/count/carsonSgit/carsonSgit.github.io?style=for-the-badge" alt="GitHub Languages" />
57+
</p>
58+
</div>
59+
60+
<div align="center"><h2> 🚀 Deploy Locally </h2></div>
61+
If you want to run it locally follow these steps:
62+
63+
### 🔧 Prerequisites:
64+
- `Git`
65+
- `Node.js`
66+
- `npm (Node Package Manager)`
67+
68+
### 📥 Installation Steps:
69+
1. Clone the repository:
70+
```bash
71+
git clone https://github.com/carsonSgit/carsonsgit.github.io.git
72+
```
73+
2. Go to the project directory:
74+
```bash
75+
cd carsonsgit.github.io
76+
```
77+
3. Install dependencies
78+
```bash
79+
npm i
80+
```
81+
**OR** if your `npm i` doesn't work
82+
83+
```bash
84+
npm i --force
85+
```
86+
4. Run locally
87+
```bash
88+
npm start
89+
```
90+
5. Open your browser at `http://localhost:3000`!
91+
92+
<br />
93+
94+
**Thank you for visiting my portfolio! 🎉**

0 commit comments

Comments
 (0)