shmolf / noted-hydrator
Designed to receive requests from note-d.app, and objectify them.
Requires
- php: >=7.4
- swaggest/json-schema: ^0.12.31
Requires (Dev)
- phpunit/phpunit: >=8.0
- squizlabs/php_codesniffer: ^3.0
- vimeo/psalm: ^4.7
This package is auto-updated.
Last update: 2024-05-05 04:06:02 UTC
README
The note'd app is/will be designed to allow the user to store notes
on their own self-hosted server.
This library is meant for said user to install in their PHP application, to help simplify
the communication between the website and their hosting service.
Since a self-hosted data-repo (your PHP application storing notes) could reference an old iteration of this library, the note application will attempt to query the host as to which schema version it accepts, and then try to comply.
For more information, please visit the note'd Github repo.
A helpful website to self-check schema and data validity.
Structure
src/
tests/
Install
Via Composer
$ composer require shmolf/noted-hydrator
If the NOTED_SCHEMA_HOST environment variable is specified
# Default value, if not specified
NOTED_SCHEMA_HOST="https://note-d.app"
Usage
// Still in the works
Change log
Please see CHANGELOG for more information on what has changed recently.
Testing
$ composer test
Contributing
Please see CONTRIBUTING and CODE_OF_CONDUCT for details.
Security
If you discover any security related issues, please email the author instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.