readme, updated package script steps
This commit is contained in:
parent
82eac74ee3
commit
f0656b8d72
2 changed files with 36 additions and 4 deletions
32
README.md
Normal file
32
README.md
Normal file
|
@ -0,0 +1,32 @@
|
||||||
|
# portfolio
|
||||||
|
|
||||||
|
For repos, work, and more
|
||||||
|
|
||||||
|
## Developing
|
||||||
|
|
||||||
|
In two terminals
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# first terminal
|
||||||
|
npm run start
|
||||||
|
|
||||||
|
# second terminal
|
||||||
|
npm run start:styles
|
||||||
|
```
|
||||||
|
|
||||||
|
## Building for production, static site
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
## Deploy steps
|
||||||
|
|
||||||
|
Requires Docker, NodeJS
|
||||||
|
|
||||||
|
_Docker container automatically performs dependency install and build_
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm run deploy
|
||||||
|
```
|
||||||
|
|
|
@ -5,10 +5,10 @@
|
||||||
"author": "Ava Gaiety W. <ava@wroten.me> (https://www.gaiety.me/)",
|
"author": "Ava Gaiety W. <ava@wroten.me> (https://www.gaiety.me/)",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"serve:styles": "npx postcss styles.css -o _site/styles.css --watch",
|
"start": "npx postcss styles.css -o _site/styles.css --watch",
|
||||||
"serve:site": "npx @11ty/eleventy --serve",
|
"start:site": "npx @11ty/eleventy --serve",
|
||||||
"build:site": "npx @11ty/eleventy",
|
"build": "npx @11ty/eleventy",
|
||||||
"build:styles": "npx postcss styles.css -o _site/styles.css --env production",
|
"postbuild": "npx postcss styles.css -o _site/styles.css --env production",
|
||||||
"test": "echo \"Error: no test specified\" && exit 1"
|
"test": "echo \"Error: no test specified\" && exit 1"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
|
|
Loading…
Add table
Reference in a new issue