||2 weeks ago|
|db/migrations||1 year ago|
|public||2 weeks ago|
|resources||2 weeks ago|
|src||2 months ago|
|.editorconfig||2 years ago|
|.gitignore||1 year ago|
|LICENSE||1 year ago|
|README.md||1 year ago|
|artemis.php||1 year ago|
|composer.json||1 year ago|
|composer.lock||1 year ago|
|config.php||2 weeks ago|
|phinx.php||1 year ago|
|routes.php||2 months ago|
- PHP 7.3+
- PDO PgSQL
- PostgreSQL 11+
Set up a local work environment
My environment is based on Apache, and is made to flawlessly work with that. I have no example configuration for anything else than Apache / PHP.
- Apache 2.4+
- mod_env: not required, but highly recommended to set once and never again environment variables.
$ git clone https://git.sr.ht/~artemis/artemix.org $ cd artemix.org $ composer install
Now, you need to point your
You should define the environment variables for
DB_DSNwill be the PostgreSQL connection string, see the PDO docs on how to create it
AUTH_TOKENwill be used for authenticating the blog's owner on
/admin. It can be generated by entering
php artemis.php new:keyand answering prompted questions.
Once you've configured your environment, you'll have to set up the database tables.
To do that, run
vendor/bin/phinx migrate, which will create the database.
You're all set!
db/: Migrations, as handled by phinx (may change for something simpler in the future)
public/: Entrypoint, static resources (e.g. icons)
index.php: Every request's entry point. It may be useful to read it to get a hang on what's happening on every request.
assets/: Every asset should be stored here
gpg/: The public ASC keys should be stored here
resources/: HTML page templates and base resources that need to be built (CSS / JS)
templates/: HTML page templates, in the twig templating format
src/: The website's source code
Actions/: Every HTTP request handler, this is what's referenced in
Commands/: Every CLI command (which must be registered in
artemis.phpto be usable)
Helpers/: Basic PHP helper functions, to make a dev's life easier
Services/: OOP service classes, this contains the core backend logic
Renderers/: A series of classes made to provide a simpler interface to render common HTML documents
Repositories/: A series of classes made to provide an interface to interact with the database in a SRP-compliant way
Types/: Basic PHP data classes to help dealing with a few types
Action.php: HTTP request handler (action) interface
Command.php: CLI command handler interface
ParsedownExtended.php: Custom snippet that wraps Parsedown as dependency. Just stupidly located
Runner.php: Core class containing all the logic required to bootstrap the request handling system
artemis.php: The CLI tool, which allows to minify base resources and create keys
config.php: The configuration file, which contains environment-agnostic and non-secret data
routes.php: The configuration file, which contains every defined Siler route
The website doesn't have a concept of "middleware", but instead relies on two mechanisms to run preliminary checks (such as the authentication guard, to make sure only authorized users can access the admin panel).
- A "route" in siler's way is simply a code snippet that will be invoked on URI match.
If a route
/a, and a route
/a/b, having the router set up as
['A', 'B']will execute the actions for
- This mechanism has been extended with one concept: continue / breaks. If an action's
__invokemethod returns the boolean value
false(and nothing else), the router won't continue to try to match actions.
The website heavily relies on PHP-DI to provide access to any instance from actions.
It is strongly advised to get to understand the logic dealt by the
methods before starting to dig further into the code.
You should never interact with the database directly from an Action (by injecting the
but you should instead create a repository that will wrap the database access request logic into clear and simple