- update readme

This commit is contained in:
Kamil Niemczycki 2023-08-06 00:26:28 +02:00
parent 70f63c8e9f
commit da04a355ac
Signed by: kamilniemczycki
GPG Key ID: 04D4E2012F969213

View File

@ -1,25 +1,32 @@
# kamilcraft.com
Project of my website - portfolio
The project uses the [API](https://github.com/kamilniemczycki/kamilcraft-api) at https://api.kamilcraft.com
The project concerns a private website at [https://kamilcraft.com](https://kamilcraft.com). The website contains information about me and my projects.
I used Vue.js in the project. Some of the content is static. The information about the projects is retrieved from the [API](https://github.com/kamilniemczycki/kamilcraft-api).
## Dependency installation
```
npm install --legacy-peer-deps
```
### Development
```
npm run serve
npm run dev
```
Application should be available under `127.0.0.1:8080` or `localhost:8080`.
Application should be available under `127.0.0.1:5173` or `localhost:5173`.
### Compilation
```
npm run build
```
The executable files should be in the `dist` folder.
### Code formatting
```
npm run lint
```