From 19eef07589b19e14d6d1c788752b4a15228eca22 Mon Sep 17 00:00:00 2001 From: Ayo Ayco Date: Mon, 8 Apr 2024 18:58:55 +0200 Subject: [PATCH] chore: update deploy script; update readme --- README.md | 24 ++++++++++++++++++++++-- package.json | 2 +- 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d830493..b6579e3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,24 @@ -# Ayo Ayco Personal Website +# Astro SSG for my personal site -This is my personal website [ayco.io](https://ayco.io) built with [astro](https://astro.build). +## Background +This is the project for generating the static files for my personal site [ayo.ayco.io](https://ayo.ayco.io) built with [Astro SSG](https://astro.build). +## Development +```bash +# clone project +$ git clone git@git.sr.ht:~ayoayco/ayco.io-astro + +# go into project dir +$ cd ./ayco.io-astro + +# install deps +$ npm i + +``` + +## Commands +| Command | Action | +| --- | --- | +| `npm start` | start dev server | +| `npm run build` | generate static files to `dist` directory | +| `npm run deploy` | run build and upload to my server | diff --git a/package.json b/package.json index 791bc2a..bb32334 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,7 @@ "build": "astro build", "preview": "astro preview", "astro": "astro", - "deploy": "astro build && scp -r dist/. ayo@ayco.io:~/ayco.io-astro/dist" + "deploy": "astro build && scp -r dist/. ayo@ayco.io:~/ayco.io-flask/dist" }, "dependencies": { "@astro-reactive/form": "^0.10.0",