This repository has been archived on 2025-12-28. You can view files and clone it, but cannot push or open issues or pull requests.
simple-blog-api/README.md
2021-06-06 12:23:50 +09:30

1.1 KiB

Simple Blog API

This is a very busted work in progress api for my website.

I do not intend to frequently add to the blog and I needed a basic way of delivering content. My intention is to have a container that contains the posts as markdown files. These files can be added via git and the CI/CD will redeploy the container (I haven't got to that yet currently just trying to get it working at all), or as will most likely happen for now I can manually deploy it.

I wanted to have a go at using a dev container so that I don't need to worry about having the dependencies on my system (except for docker of course).

Usage

When the project is opened in vscode it will prompt to reopen in container, do so.

Once this is done, for the first time or on a rebuild, one can simply run:

pip install -r requirements.txt

To run the development server run, you MUST have run pip install first:

gunicorn -c gunicorn.config.py dev:api

Caveats

Currently there is no git in the container so you can't see what's been edited or not, git will have to be managed from the host.

That about covers everything.