README.md 1.74 KB
Newer Older
1
[![pipeline status](https://gitlab.sokoll.com/moritz/blog/badges/master/pipeline.svg)](https://gitlab.sokoll.com/moritz/blog/-/commits/master)
2
3
# Disclaimer
This Project is a project for me to learn included technologies/langauges. Its not ment for production environments.
Moritz Sokoll's avatar
Moritz Sokoll committed
4
5
# PyBlog
## a blog written in python with flask
6
7
PyBlog is a blogging system written in python. Its one of my first Docker using projects

Moritz Sokoll's avatar
Moritz Sokoll committed
8
9
10
11
12
13
## Codebase
| Folder | Description |
| ------ | ----------- |
| [src](/src) | web frontend for pyblog mainly written in typescript, sass and the server in python | 
| [api](/api) | api for pyblog written in python |

14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
## Requirements
### Docker
Docker is used to build a container for the Server
### Make(optional)
Make is used to make building of Docker images easier
### Docker Compose
docker-compose can be used to start and stop the application easier

## Installation
### Git
you can clone this repository with `git clone https://gitlab.sokoll.com/moritz/blog.git`
### Docker
in the future the docker images might be on a registry like docker hub

## Running
### Docker compose
you can run `docker-compose up -d` to run this application in detached mode and you can stop it with `docker-compose down`
### Docker
As soon as a database server (`mariadb`) is involved, you might need to setup a network between the containers, due to docker-compose automatically routing the connection to the services name
#### with Make
If you can use make do `make docker-run-main` to run the main application in detached mode and do `make docker-run-api` to run the api
#### without Make
you can also start these containers directly from docker: `docker run --name your_name -p5000:5000 -d pyblog:latest`
#### Ports
the api exposes port 5001 and the main application exposes port 5000