cv-site/README.md

23 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2021-12-16 10:41:15 +01:00
[![Build Status](https://dev.jatus.tech/api/badges/Jatus/cv-site/status.svg)](https://dev.jatus.tech/Jatus/cv-site)
2021-10-18 11:58:11 +02:00
# My CV
I created this website to collect and present all my experiences and works. I made these pages using Typescript and Svelte. To manage the content, I've created a simple system to load content from a couple of JSON files that define where to put the information.
2021-10-02 14:29:49 +02:00
2021-10-18 11:58:11 +02:00
## How to build
2021-10-02 14:29:49 +02:00
To build this project, you need to run two commands on a machine with Node.js
2021-10-02 14:29:49 +02:00
2021-10-18 11:58:11 +02:00
- ```npm install```
- ```npm run build```
2021-10-02 14:29:49 +02:00
2021-10-18 11:58:11 +02:00
then you can load the built website on a webserver
2021-10-02 14:29:49 +02:00
2021-10-18 11:58:11 +02:00
## How to edit the content
2021-10-02 14:29:49 +02:00
2021-10-18 11:58:11 +02:00
I've defined the content structure through a JSON schema that you can find in /src/model/schema.json.
There are three files (portfolio.json, schema.json, training.json) that define the content of the associated section.
Svelte support HMR to speed up the development.
To run the development server:
- ```npm install```
- ```npm run dev```
2021-10-02 14:29:49 +02:00
2021-10-18 11:58:11 +02:00
Then you can visit the development site on http://localhost:3000 when a file is edited the server re-renders the page that you are visiting.