/hugo-exec-sh

My personal website for blogging and :pencil2: note-taking

Primary LanguageCSSMIT LicenseMIT

My personal website for blogging and ✏️ note-taking

Coverage Status Known Vulnerabilities Docker Stars Docker Pulls

Uses Ghost blogging platform for publishing and managing content online

Features

  • 👻 Ghost blogging platform publishing platform ✅
  • Simple and 💫 lightweight theme ✅

How to use

Use it in your terminal

Using it in your terminal requires Docker installed in your system.

Run the Docker image in a container

Detach from the container and expose port 5302.

docker run -d -p "5302:3000" hfreire/hugo-exec-sh

How to build

Clone the GitHub repo
git clone https://github.com/hfreire/hugo-exec-sh.git
Change current directory
cd hugo-exec-sh
Run the NPM script that will build the Docker image
npm run build

How to deploy

Deploy it from your terminal

Deploying it from your terminal requires terraform installed on your system and an antifragile infrastructure setup available in your AWS account.

Clone the GitHub repo
git clone https://github.com/hfreire/hugo-exec-sh.git
Change current directory
cd hugo-exec-sh
Run the NPM script that will deploy all functions
npm run deploy

Available deployment environment variables

Variable Description Required Default value
VERSION The version of the app. false latest
ANTIFRAGILE_STATE_AWS_REGION The AWS region used for the antifragile state . false undefined
ANTIFRAGILE_STATE_AWS_S3_BUCKET The AWS S3 bucket used for the antifragile state. false undefined
ANTIFRAGILE_STATE_AWS_DYNAMODB_TABLE The AWS DynamoDB table used for the antifragile state. false undefined
ANTIFRAGILE_INFRASTRUCTURE_DOMAIN_NAME The domain used for the antifragile infrastructure. true undefined

How to contribute

You can contribute either with code (e.g., new features, bug fixes and documentation) or by donating 5 EUR. You can read the contributing guidelines for instructions on how to contribute with code.

All donation proceedings will go to the Sverige för UNHCR, a swedish partner of the UNHCR - The UN Refugee Agency, a global organisation dedicated to saving lives, protecting rights and building a better future for refugees, forcibly displaced communities and stateless people.

License

Read the license for permissions and limitations.