4in1_ws_web/README.md
2025-04-28 14:47:25 +03:00

68 lines
1.6 KiB
Markdown

# 4in1_io_web
This is a source code of 4in1.ws web site.
## Features
- it's not just blog, you can create any page with any address
- posts and pages are written in Markdown:
- supports syntax highlighting in code blocks
- supports embedding of uploaded files and image resizing
- rss feed
- dark theme
- ultra fast on backend:
- written from scratch
- no heavy frameworks
- no "classic" template engine
- vanilla php templates designed from scratch (because why not)
- thus, no overhead from templates "compilation"
- all strings are transparently escaped unless explicitly specified not to
- ultra fast on frontend:
- written from scratch
- simple readable ECMAScript 5.1 scripts
- no modern web bullshit like webpack or babel
- simple build system that just works
- secure:
- CSRF protection
- automatic XSS protection in templates
- see [this section](#bug-bounty) below
## Requirements
- PHP >= 8.1, with following extensions:
- mysqli
- gd
- MariaDB server
- Composer
- Node.JS
- SCSS compiler, e.g. sassc
## Configuration
Should be done by copying config.yaml.example to config.yaml and customizing it.
## Installation
It uses https://github.com/sixlive/parsedown-highlight which you'll need to install using Composer, but since that
package's manifest is a bit outdated you have to pass `--ignore-platform-reqs` to composer.
TODO
## Logging
TODO
## Deploying
```
make deploy
```
## Bug bounty
I take security very seriously. If you found an exploitable vulnerability in _my_ code, please contact me by email.
I'm willing to pay $50 to $500 in crypto (depending on severity) for every discovered vulnerability.
## License
GPLv3