jasm1nii / jasmines-journal
my personal webbed site
Fund package maintenance!
Ko-Fi
Installs: 4
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 1
Forks: 0
Open Issues: 5
Language:SCSS
Type:project
Requires
- php: >=8.0
- ext-date: *
- ext-dom: *
- ext-fileinfo: *
- ext-libxml: *
- ext-pdo: *
- ext-pdo_mysql: *
- indieweb/mention-client: ^1.2
- league/commonmark: ^2.4
- phpmailer/phpmailer: ^6.8
- twig/intl-extra: ^3.7
- twig/markdown-extra: ^3.7
- twig/twig: ^3.0
README
welcome to my hand-crafted personal website and coding sandbox ðŸ›
local deployment guide
base requirements
-
PHP 8 or newer.
-
composer for updating PHP dependencies.
if you'd prefer not to install composer globally, the executable
composer.phar
file (located in the/bin
directory) can be used instead - more on that in the instructions. -
MariaDB or MySQL for the database.
general instructions
-
clone this repository to your machine:
-
via
composer
(global installation) - this will automatically install the required dependencies:-
latest:
composer create-project jasm1nii/jasmines-journal:dev-main
-
stable:
composer create-project jasm1nii/jasmines-journal
-
-
via
git
CLI:-
latest:
git clone https://github.com/jasm1nii/jasmines-journal
-
stable:
git clone https://github.com/jasm1nii/jasmines-journal --branch (version tag)
-
-
via direct download as a
.zip
archive:
-
-
if you haven't already, install the required dependencies:
-
via
composer
(global installation):composer install
-
via
composer.phar
:php bin/composer.phar install
-
-
configure your web server to use
/public_html
as the document root, as well as to redirect requests for nonexistent files to/public_html/index.php
.- for apache, an
.htaccess
file is already included to handle the latter, but ensure to set the former in yourhttpd.conf
file.
- for apache, an
-
that's it! you can now view this site at whatever localhost address you've set 👾
additional configuration
per version 2.3, a guestbook_sample.sql
file is provided in the /resources/databases
directory. to use it, you'll need to import the file manually to your server database. after that, tweak any parameters as needed in /config/env_sample.ini
and /config/src_paths.php
.