diff --git a/README.md b/README.md index 60b9281..530dca3 100644 --- a/README.md +++ b/README.md @@ -2,36 +2,40 @@ tiny_personal_website ===================== screenshot of jessebot.work which serves as an example website. It features a picture of Jesse a person with blue hair that is almost 30. a blurb about them that you can read in config/config.yaml and link icons to github, gitlab, and linkedin. + +[![Github tag](https://badgen.net/github/tag/Naereen/Strapdown.js)](https://github.com/Naereen/Strapdown.js/tags/) + This is a small Python based personal website aimed first and foremost at being a resume. I originally wrote this 7 or 8 years ago, and recently absolutely borked my newer website, resulting in me quickly resurrecting this thing in about a day and a half. This one does the same thing, but better, and faster, with less js. -Feel free to take anything you need :) But keep it open source. [You gotta.](./LICENSE) +Feel free to take anything you need :) But keep it open source. Under the Hood -------------- -* Bootstrap v5 - frontend js/css -* Flask - backend routing -* Gunicorn - serving website -* YAML - config file +![made-with-bootstrap](https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white) +![made-with-python](https://img.shields.io/badge/Python-FFD43B?style=for-the-badge&logo=python&logoColor=blue) +![made-wth-flask](https://img.shields.io/badge/Flask-000000?style=for-the-badge&logo=flask&logoColor=white) +![made-with-docker](https://img.shields.io/badge/Docker-2CA5E0?style=for-the-badge&logo=docker&logoColor=white) -* The Open Source Community <3 - answers to all your questions for free +[![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](http://perso.crans.org/besson/LICENSE.html) -## Dev and Testing +## Getting Started -1. Clone this github repo into your desired webroot. +Clone this github repo into your desired webroot, and install dependencies: +`pip3.10 install -r requirements.txt` -2. Install missing libraries if any: `pip3.10 install -r requirements.txt` +You can configure everything (e.g. website title, your photo, quote, etc) +by editing `config.yaml` and replacing all the Jesse data with your own. -3. You can configure everything (e.g. website title, your photo, quote, etc) - by editing `config.yaml` and replacing all the Jesse data with your own. +All changes to HTML, CSS, and Python, or your core YAML will require a +restart of gunicorn or a rebuild of the docker container. -5. All changes to HTML, CSS, and Python, or your core YAML will require a - restart of gunicorn or a rebuild of the docker container. +### Testing -6. for docker, you can just do: +For docker, you can just do: ```bash docker build . -t @@ -40,7 +44,7 @@ Under the Hood docker run --rm -p 8000:8080 ``` - For testing locally, _without_ a docker rebuild: +For testing locally with gunicorn, _without_ a docker rebuild: ```bash gunicorn app:app ``` @@ -58,10 +62,3 @@ gunicorn --worker-tmp-dir /dev/shm app:app ``` And the container port of note is port 8080. - - -## Frontend Dev Notes -I found [this guide](https://stackoverflow.com/questions/68558955/bootstrap-centering-container-in-the-middle-of-the-page) -on vertically centering items and it helped a lot. Basically both the body and -base container you have need to be h-100 and vh-100 and for extra security, -add `min-height: 100vh;` to the CSS for the body.