You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

79 lines
2.0 KiB

2 years ago
# Container Critique
2 years ago
![container-critique-logo](container-critique.png)
2 years ago
This is a blog based on Pythons Flask framework.
The blog is intended to be used to review and critique things.
## Features/To-Dos
2 years ago
- [x] Accounts
2 years ago
- [x] Login
- [x] Logout
- [x] Register
2 years ago
- [ ] Review blog entries
- [x] Writing entries
2 years ago
- [ ] Editing entries
- [ ] Deleting entries
2 years ago
- [x] Infinite-scroll blog page
- [x] Archive page
- [x] Months as headings
- [x] Links to scrolling blog page
- [x] Links to standalone article
- [x] Standalone article page
- [x] Links to scrolling blog page
2 years ago
- [x] RSS feed
2 years ago
- [ ] Eye candy
- [ ] Star rating
- [x] Rich text editor
- [ ] CSS for all tags
2 years ago
- [x] Navigation
- [x] Header
- [x] Footer
- [x] Switchable CSS
- [x] CSS dark-theme
- [x] CSS light-theme
- [x] Docker installation
2 years ago
- [x] Logo
2 years ago
## Usage
## Deployment
### PIP/Python
- `git clone https://github.com/tiyn/container-critique`
- `cd container-critique/src`
- edit the `config.py` file according to your needs
- `pip3install -r requirements.txt` - install depenencies
- run `python app.py`
- blog is available on port 5000
### Docker
Make sure you copy an example `config.py` and edit it before running the container.
The `config.py` can be found in the `src` folder.
#### Volumes
Set the following volumes with the -v tag.
2 years ago
| Volume-Name | Container mount | Description |
| ------------- | ---------------------- | ---------------------------------- |
| `config-file` | `/blog/config.py` | Config file |
| `data` | `/blog/data` | Directory for data |
| `css` | `/blog/static/css` | (optional) Directory for css files |
2 years ago
#### Ports
Set the following ports with the -p tag.
| Container-Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- |
| `5000` | `80` | TCP | HTTP port |
#### Example run-command
An example run command is shown in `rebuild.sh`.