Skip to content

Commit 2dd87fd

Browse files
committed
📝 add readme
1 parent 33f8618 commit 2dd87fd

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

README.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Sat Naing Portfolio & Blog
2+
3+
![Sat Naing's Terminal](https://user-images.githubusercontent.com/53733092/172165697-a69d61dd-98f5-4237-910c-5915b5b8952b.png)
4+
![ts](https://badgen.net/badge/Built%20With/TypeScript/blue) [![Netlify Status](https://api.netlify.com/api/v1/badges/81fdb91d-c06f-46c2-b18d-dfc6f090f281/deploy-status)](https://app.netlify.com/sites/terminal-sn/deploys)
5+
6+
My perfolio website in terminal version developed with ReactJS and TypeScript. In this project, styled-components library is used for styling. Multiple themes supported.
7+
8+
## Features
9+
10+
- Responsive Design 📱💻
11+
- Multiple themes 🎨
12+
- Autocomplete feature ✨ (TAB | Ctrl + i)
13+
- Go previous and next command ⬆️⬇️
14+
15+
## Tech Stack
16+
17+
**Frontend** - [React](https://reactjs.org/), [TypeScript](https://www.typescriptlang.org/)
18+
**Styling** - [Styled-Components](https://styled-components.com/)
19+
**UI/UX** - [Figma](https://figma.com/)
20+
**State Management** - [ContextAPI](https://reactjs.org/docs/context.html)
21+
**Deployment** - [Netlify](https://app.netlify.com/)
22+
23+
## Lighthouse Score
24+
25+
<p align="center">
26+
<img width="710" alt="Sat Naing Terminal Lighthouse Score" src="https://user-images.githubusercontent.com/53733092/172168920-d05dd889-802e-48f3-8266-75e0357f561e.png">
27+
</p>
28+
29+
## Running Locally
30+
31+
Clone the project
32+
33+
```bash
34+
git clone https://github.com/satnaing/terminal-portfolio.git
35+
```
36+
37+
Go to the project directory
38+
39+
```bash
40+
cd terminal-portfolio
41+
```
42+
43+
Remove remote origin
44+
45+
```bash
46+
git remote remove origin
47+
```
48+
49+
Install dependencies
50+
51+
```bash
52+
npm install
53+
```
54+
55+
Start the server
56+
57+
```bash
58+
npm run dev
59+
```
60+
61+
## Inspiration and Credits
62+
63+
Here are some inspiration for this kind of terminal website. Only some features and functionalities are inspired by these following websites. All codes are written on my own.
64+
65+
- [term m4tt72](https://term.m4tt72.com/)
66+
- [Forrest](https://fkcodes.com/)
67+
68+
## Author
69+
70+
- [@satnaing](https://satnaing.dev)

0 commit comments

Comments
 (0)