Skip to content

Commit 1d053ed

Browse files
committed
Feat: improvements on the README
1 parent 3f38000 commit 1d053ed

File tree

1 file changed

+75
-13
lines changed

1 file changed

+75
-13
lines changed

README.md

Lines changed: 75 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,83 @@
11
# DavidsDvm-Webpage
22

3-
Personal web page where i talk about myself
3+
This repository contains my personal portfolio web page built with Vue.js. On this site, I share insights about my background, showcase my projects, and provide ways to get in touch.
44

5-
## Project setup
6-
```
7-
npm install
8-
```
5+
## Table of Contents
96

10-
### Compiles and hot-reloads for development
11-
```
12-
npm run serve
13-
```
7+
- [Demo](#demo)
8+
- [Features](#features)
9+
- [Technologies Used](#technologies-used)
10+
- [Project Setup](#project-setup)
11+
- [Development](#development)
12+
- [Production Build](#production-build)
13+
- [Customization](#customization)
14+
- [Contact](#contact)
15+
16+
## Demo
17+
18+
A live version of the project is available here:
19+
[View Live Demo](https://davidsdvm.com/)
20+
21+
## Features
22+
23+
- **Responsive Design:** Optimized for desktops, tablets, and mobile devices.
24+
- **Dynamic Content:** Interactive sections to showcase projects and personal achievements.
25+
- **Smooth Navigation:** User-friendly interface with seamless transitions.
26+
- **Modern UI:** Clean and minimalistic design that reflects my personal style.
27+
28+
## Technologies Used
29+
30+
- **Vue.js:** The progressive JavaScript framework powering the front end.
31+
- **HTML5 & CSS3:** Markup and styling for a modern and accessible design.
32+
- **JavaScript:** Core language for interactive components.
33+
- **npm:** For dependency management and project scripts.
34+
35+
## Project Setup
36+
37+
To get started locally, follow these steps:
38+
39+
1. **Clone the repository:**
40+
41+
```bash
42+
git clone https://github.com/DavidsDvm/DavidsDvm-Webpage.git
43+
```
1444

15-
### Compiles and minifies for production
45+
2. **Navigate into the project directory:**
46+
47+
```bash
48+
npm install
49+
```
50+
51+
3. **Install dependencies:**
52+
53+
```bash
54+
yarn
55+
```
56+
57+
## Development
58+
59+
To run the project locally with hot-reloading:
60+
61+
```bash
62+
yarn serve
1663
```
17-
npm run build
64+
65+
Once the server is running, open your browser and navigate to http://localhost:8080 (or the port specified in your terminal) to view the application.
66+
67+
## Production Build
68+
When you are ready to deploy the site, compile and minify the application with:
69+
70+
```bash
71+
yarn build
1872
```
1973

20-
### Customize configuration
21-
See [Configuration Reference](https://cli.vuejs.org/config/).
74+
## Customization
75+
76+
For more advanced configuration options, please refer to the Vue CLI Configuration Reference.
77+
78+
## Contact
79+
80+
For any questions, suggestions, or feedback, feel free to reach out:
81+
82+
83+
- LinkedIn: [Check here](https://www.linkedin.com/in/davidsdvm)

0 commit comments

Comments
 (0)