mw-site/README.md

49 lines
1.1 KiB
Markdown

# Mike Wink Website
That is the static website for Mike Wink. It is powered by pure HTML and Tailwind CSS. The index is a PHP file so that I
can have a dynamic elements.
## Installation
Do a normal `npm install` to install dependencies. See the Tailwind CSS [documentation](https://tailwindcss.com/docs) for details.
### Run dev _watch_
```shell
npx tailwindcss \
-i ./src/css/styles.css \
-o public/build/styles.css \
--jit \
--purge="./public/**/*.php" \
--watch
````
### Run production build
```shell
NODE_ENV=production \
npx tailwindcss \
-i ./src/css/styles.css \
-o public/build/styles.css \
--jit \
--purge="./public/**/*.php" \
--minify
```
## Serving the site
Use the PHP commandline server to serve the site locally.
```shell
php -S localhost:8000 -t ./public
```
## Used assets
- Background pattern "Topography" from [Hero Patterns](https://heropatterns.com)
- D-DIN fonts from [1001 Fonts](https://www.1001fonts.com/users/datto/)
- Color palette from [Coolers](https://coolors.co/3d5a80-98c1d9-e0fbfc-ee6c4d-293241)
- SVG icons from [Simple Icons](https://simpleicons.org/)