Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jsorrell/www.jacksorrell.com
My personal website
https://github.com/jsorrell/www.jacksorrell.com
Last synced: 4 days ago
JSON representation
My personal website
- Host: GitHub
- URL: https://github.com/jsorrell/www.jacksorrell.com
- Owner: jsorrell
- License: gpl-3.0
- Created: 2018-01-10T23:12:09.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-02T07:31:04.000Z (about 2 years ago)
- Last Synced: 2024-10-31T11:36:39.287Z (about 2 months ago)
- Language: Go
- Homepage: https://www.jacksorrell.com
- Size: 2.61 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# www.jacksorrell.com
[![js-happiness-style](https://img.shields.io/badge/code%20style-happiness-brightgreen.svg)](https://github.com/JedWatson/happiness)My personal website at
## Configuration
Run `./www.jacksorrell.com genconfig` to generate a sample configuration yaml file.
Modify this config file as needed.All config options can also be passed as flags. Run `./www.jacksorrell.com help` for more information.
### _Options_
```yaml
# The commented out fields are reqired# General
logLevel: warn # Valid Levels: panic, fatal, error, warn, warning, info, debug# Server
server:
port: 3000# Contact Form
contact:
mailgun:
# publicValidationKey: pubkey-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# privateAPIKey: key-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
email:
# domain: mg.example.com
# toAddress: [email protected]
subject: Contact Form Message
# Maximum input lengths
maxLengths:
name: 70
email: 254
message: 10000
```## Building from Source
Node.js and NPM required to generate assets.
### Generate Assets
`npx gulp && go generate`
### Compile
`go build`
All assets will be embedded in the executable (except for the configuration).
## Development
Node.js and NPM required to generate assets.
### Development Mode
To automatically recompile assets and reload the browser
on changes using browsersync, run `npx gulp dev`Compile using `go install -tags 'dev'`. This will not cache any assets. They will be reread from disk.
## Systemd
### _Example Configuration_
```systemd
[Unit]
Description=www.jacksorrell.com server
After=network.target[Service]
User=example_user
Group=example_group
WorkingDirectory=/var/www/www.jacksorrell.com
ExecStart= start
Restart=on-failure[Install]
WantedBy=multi-user.target
```## Design Choices
- Original favicon created using font [The Wastes of Space](http://www.fontspace.com/chequered-ink/the-wastes-of-space).- Favicons automatically generated.
- Use contact form to protect email from spambots.
- Contact form sends email via Mailgun and is protected from bots
by a honeypot input.- `www.jacksorrell.com/resume` permanently redirects to
`www.jacksorrell.com/resume/`.- Embedding assets allows for portability.
_Updated September 2018_