36 lines
1.3 KiB
Markdown
36 lines
1.3 KiB
Markdown
# 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:
|
|
|
|
```shell
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
To run the development server run, you MUST have run `pip install` first:
|
|
```shell
|
|
gunicorn -c gunicorn.config.py wsgi:api
|
|
```
|
|
|
|
Due to production container using .pipfiles and pipenv make sure to run the following to regenerate the pip files before a release commit:
|
|
```shell
|
|
# Run this in dev container
|
|
pipenv install -r requirements.txt
|
|
```
|
|
|
|
## 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. |