jpcom-website

Terraform and Hugo configuration for the johnpearsall.com website.

Report Bug · Request Feature

About The Project

This repository is for the Terraform configuration of the johnpearsall.com website.

Project scope:

• Core elements such as the domain, TLS certificates, and DNS are delegated to the jpcom-infrastructure repo.
• The website hosting element as well as the website contents are contained in this repo.

(back to top)

Built With

(back to top)

Getting Started

Hugo is required to build the static website. We are managing Terraform via tfenv which manages Terraform environments similarly to rbenv.

(back to top)

Prerequisites

Follow the linked installation instructions under each tool.

• Hugo
  • Follow the Hugo installation guide for your OS.
• tfenv
  • Follow the installation directions from the project's README.

(back to top)

Configuration

• Follow Hugo's documentation to Configure Hugo
  • Many of the fields are fairly self-explanatory. Here is a description of some of the more cryptic options.
    • enableThemeToggle: Setting this to true will enable a toggle for light/dark/system mode if your theme supports it.
    • [taxonomies]: Taxonomies are ways of grouping your content. I would refer to the documentation.
• The tfenv tool will manage Terraform versions for you.
  • Just make sure your tf/.terraform-version matches the tf/required_version defined in tf/providers.tf.

(back to top)

Usage

⚠️ This section is under construction until I can resolve a few issues.

• [ ] Create jpcom-infrastructure repository and pull resources from the module outputs.
• [ ] Convert some of the hardcoded values such as domain names, etc. to Terraform variables.

(back to top)

Roadmap

• [ ] Create tests for Hugo
• [ ] Create tests for Terraform
• [ ] Research multiple image display options.
  • [ ] Implement image display options.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Top contributors:

License

Distributed under the GPL-3.0 License. See LICENSE.txt for more information.

(back to top)

Contact

John Pearsall - @notoriousjwp - jwp@johnpearsall.com

Project Link: https://github.com/jpearsall/jpcom-website

(back to top)

Acknowledgments

• Inspired by jscom-blog by @johnsosoka
• Badges provided by Shields.io (We do need no stinkin' badges!)
• The lovely hello-friend-ng theme for Hugo.
• Shoutout to @draik for testing!

(back to top)