crimsontome.com/README.md

CrimsonTome's Blog

My personal blog documenting my journey into open-source development alongside other things.
Created with 11ty, hosted in a docker container on my VPS

• CrimsonTome's Blog
  • Development
  • Building
    • Node
    • Docker
  • Dockerfile
    • Ouroboros
  • Contributing
  • Changelog
  • License

Development

• clone the repo
• run npm i to install dependencies
• npm run serve
• make some changes and watch them update in the browser

Building

Node

• run npm run build

Docker

The site can also be built and ran inside a docker container when you are in the base of the repo:

• sudo docker build -t crimsontome-blog .
• sudo docker run -itd -p unused-port-number:80 crimsontome-blog
• visit localhost:port or ip:port if you are hosting on a VPS and the site should be available to view

Dockerfile

FROM node:18-alpine3.15 as npmpackages
WORKDIR /app
COPY package.json .
RUN npm install

FROM node:18-alpine3.15 as builder
WORKDIR /app
COPY --from=npmpackages /app /app
COPY . .
RUN npm run build

FROM nginx:1.17.10-alpine
RUN rm -r /usr/share/nginx/html/
COPY --from=builder /app/_site/ /usr/share/nginx/html/

Ouroboros

Using a tool like Ouroboros, you can automatically update containers without the need for restarts. This site is setup with that so you can (instead of building it yourself like above) with sudo docker run -d -p unused-port-number:80 crimsontome427:crimsontome-blog

Contributing

See CONTRIBUTING.md for information on adding to this repository.

Changelog

Run ./changelog to generate the changelog after your commit, then git add . && git commit --amend --no-edit to generate the changelog
The changelog is available here

License

crimsontome-blog is released under the MIT License. The full license text is included in the LICENSE file in this repository. Tldr legal have a great summary of the license if you're interested.