Skip to content

Commit e01baef

Browse files
committed
Readme
1 parent d6008e4 commit e01baef

1 file changed

Lines changed: 67 additions & 0 deletions

File tree

README.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# saberls.github.io
2+
3+
**My personal portfolio**
4+
This is my personal webpage and digital business card, where you'll find links to contact me and information about me.
5+
6+
## 🔗 Live Preview
7+
8+
Check out the website in action: [https://saberls.github.io](https://saberls.github.io)
9+
10+
## 🛠️ Technologies Used
11+
12+
This project was built using:
13+
14+
- **HTML5**
15+
- **CSS3**
16+
- **JavaScript**
17+
- **Prettier** (code formatting)
18+
- **Stylelint** (CSS linting)
19+
- **ESLint** (JavaScript linting)
20+
21+
## 📁 Project Structure
22+
23+
```
24+
.
25+
├── index.html # Main landing page
26+
├── index.css # Main CSS styles
27+
├── cubeHoverRotate.js # Interactive effects (e.g., rotating cube)
28+
├── icons/ # Icons and images
29+
├── .editorconfig # Editor settings
30+
├── .gitignore # Git ignored files
31+
├── .prettierignore # Files ignored by Prettier
32+
├── .stylelintrc.mjs # Stylelint configuration
33+
├── eslint.config.mjs # ESLint configuration
34+
├── package.json # Project metadata and dependencies
35+
├── package-lock.json # Dependency lock file
36+
└── LICENSE # MIT License
37+
```
38+
39+
## 🚀 Running Locally
40+
41+
1. Clone the repository:
42+
43+
```bash
44+
git clone https://github.com/SaberLS/saberls.github.io.git
45+
cd saberls.github.io
46+
```
47+
48+
2. Open the `index.html` file in your browser, or run a local development server:
49+
50+
```bash
51+
npx serve .
52+
```
53+
54+
## 📦 Installing Dependencies (Optional)
55+
56+
If you want to use tools like ESLint, Prettier, or Stylelint:
57+
58+
```bash
59+
npm install -D
60+
```
61+
62+
## 📄 License
63+
64+
This project is licensed under the [MIT License](LICENSE).
65+
66+
---
67+

0 commit comments

Comments
 (0)