readme overhaul

main
CTome 2022-09-04 01:48:36 +01:00 committed by GitHub
parent c47dd1165a
commit 7e951ad37d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 45 additions and 4 deletions

View File

@ -1,11 +1,52 @@
# 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
## Development
- clone the repo
- run `npm i` to install dependencies
- npm `run serve`
- make some changes and watch them update in the browser
After abandoning the github pages blog, I had many static site generators and hosting providers recommended to me aside from Jekyll and GHPages. I had already tried Eleventy with GHPages and wanted to try that with Netlify. So, that is what I am doing.
This blog uses the [eleventy base blog](https://github.com/11ty/eleventy-base-blog) as a framework.
## Building
EDIT: Site is now hosted on my Docker server as the base url for my site has been broken for some time, and this prevents Netlify from randomly breaking npm packages. Can be viewed at <https://blog.crimsontome.com>
### Node
Much of the documentation will be through blog posts rather than here, for now anyway. You can read the first blog [here](https://blog.crimsontome.com/posts/making-your-own-blog/).
- 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
```dockerfile
FROM node:10-alpine3.9 as npmpackages
WORKDIR /app
COPY package.json .
RUN npm install
FROM node:10-alpine3.9 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](https://github.com/pyouroboros/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](CONTRIBUTING.md) for information on adding to this repository.
## License
crimsontome-blog is released under the MIT License. The full license text is included in the [LICENSE](LICENSE.md) file in this repository. Tldr legal have a [great summary](https://tldrlegal.com/license/mit-license) of the license if you're interested.