josh/README.md

# fwdekker.com
The source code of [my personal website](https://fwdekker.com/).

## Development
### Requirements
* [npm](https://www.npmjs.com/)

### Setting up
```shell script
# Install dependencies (only needed once)
$> npm ci
```

### Building
```shell script
# Build the application in `dist/` for development
$> npm run dev
# Same as above, but automatically rerun it whenever files are changed
$> npm run dev:server
# Build the application in `dist/` for deployment
$> npm run deploy
# Remove build files
$> npm run clean
```

### Testing
```shell script
# Run tests
$> npm test
# Run tests with coverage
$> npm run coverage
```
Add README.md and improve build script 2019-10-21 03:32:49 +02:00			`# fwdekker.com`
			`The source code of [my personal website](https://fwdekker.com/).`

			`## Development`
Use Webpack for bundling dependencies 2019-10-31 19:01:41 +01:00			`### Requirements`
Migrate to Grunt as build tool 2019-10-26 19:29:00 +02:00			`* [npm](https://www.npmjs.com/)`

Add and document clean command And recommend using `npm ci` instead of `npm install` because the latter updates `package-lock.json` which is not necessary for most contributors. 2019-11-01 12:05:26 +01:00			`### Setting up`
Add README.md and improve build script 2019-10-21 03:32:49 +02:00			```shell script
Migrate to Grunt as build tool 2019-10-26 19:29:00 +02:00			`# Install dependencies (only needed once)`
Add and document clean command And recommend using `npm ci` instead of `npm install` because the latter updates `package-lock.json` which is not necessary for most contributors. 2019-11-01 12:05:26 +01:00			`$> npm ci`
Add README.md and improve build script 2019-10-21 03:32:49 +02:00			```
Migrate to Grunt as build tool 2019-10-26 19:29:00 +02:00
Add and document clean command And recommend using `npm ci` instead of `npm install` because the latter updates `package-lock.json` which is not necessary for most contributors. 2019-11-01 12:05:26 +01:00			`### Building`
Migrate to Grunt as build tool 2019-10-26 19:29:00 +02:00			```shell script
Move build output to `dist/` 2020-05-03 20:52:28 +02:00			# Build the application in `dist/` for development
Use Webpack for bundling dependencies 2019-10-31 19:01:41 +01:00			`$> npm run dev`
Add watcher for better builds Fixes #137. 2020-09-30 15:00:57 +02:00			`# Same as above, but automatically rerun it whenever files are changed`
			`$> npm run dev:server`
Move build output to `dist/` 2020-05-03 20:52:28 +02:00			# Build the application in `dist/` for deployment
Use Webpack for bundling dependencies 2019-10-31 19:01:41 +01:00			`$> npm run deploy`
Add and document clean command And recommend using `npm ci` instead of `npm install` because the latter updates `package-lock.json` which is not necessary for most contributors. 2019-11-01 12:05:26 +01:00			`# Remove build files`
			`$> npm run clean`
Migrate to Grunt as build tool 2019-10-26 19:29:00 +02:00			```

Add and document clean command And recommend using `npm ci` instead of `npm install` because the latter updates `package-lock.json` which is not necessary for most contributors. 2019-11-01 12:05:26 +01:00			`### Testing`
Add README.md and improve build script 2019-10-21 03:32:49 +02:00			```shell script
Add and document clean command And recommend using `npm ci` instead of `npm install` because the latter updates `package-lock.json` which is not necessary for most contributors. 2019-11-01 12:05:26 +01:00			`# Run tests`
Set up testing framework 2019-10-29 18:36:26 +01:00			`$> npm test`
Fix #51 And reformat the package.json while I'm at it. 2019-11-09 19:36:23 +01:00			`# Run tests with coverage`
			`$> npm run coverage`
Add README.md and improve build script 2019-10-21 03:32:49 +02:00			```