updated readme
This commit is contained in:
parent
618e92110d
commit
e04e90c627
46
README.md
46
README.md
@ -1,38 +1,22 @@
|
||||
# create-svelte
|
||||
# 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.
|
||||
|
||||
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte);
|
||||
## How to build
|
||||
|
||||
## Creating a project
|
||||
To build this project, you need to run two commands on a machine with Nodejs
|
||||
|
||||
If you're seeing this, you've probably already done this step. Congrats!
|
||||
- ```npm install```
|
||||
- ```npm run build```
|
||||
|
||||
```bash
|
||||
# create a new project in the current directory
|
||||
npm init svelte@next
|
||||
then you can load the built website on a webserver
|
||||
|
||||
# create a new project in my-app
|
||||
npm init svelte@next my-app
|
||||
```
|
||||
## How to edit the content
|
||||
|
||||
> Note: the `@next` is temporary
|
||||
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```
|
||||
|
||||
## Developing
|
||||
|
||||
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
|
||||
# or start the server and open the app in a new browser tab
|
||||
npm run dev -- --open
|
||||
```
|
||||
|
||||
## Building
|
||||
|
||||
Before creating a production version of your app, install an [adapter](https://kit.svelte.dev/docs#adapters) for your target environment. Then:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
> You can preview the built app with `npm run preview`, regardless of whether you installed an adapter. This should _not_ be used to serve your app in production.
|
||||
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.
|
Loading…
Reference in New Issue
Block a user