README

PHP >= 7.4
PHP sqlite3 extension
PHP json extension (for JSON/REST API)
PHP soap extension (for SOAP API)
Composer (recommended for autoloading)
A web server (Apache, Nginx, or PHP's built-in server)

Installation & Deployment

Detailed installation and deployment instructions are provided within the documentation for each API type:

For JSON/REST API: Please refer to JSON/REST API Deployment Guide.
For SOAP API: Please refer to SOAP API Deployment Guide.

General Steps:

Clone the repository:

git clone https://github.com/iquipe/sqlite_json_handler.git
cd sqlite_json_handler

Navigate to the desired API handler directory:

cd sqlite_json_handler  # or cd sqlite_soap_handler

Install dependencies:
```
composer install
```

Set Permissions: Ensure the databases/ and backups/ directories within the chosen handler's path are writable by the web server.

# Inside sqlite_json_handler or sqlite_soap_handler
mkdir -p databases backups
sudo chmod -R 775 databases backups
# Adjust ownership if necessary, e.g., sudo chown -R www-data:www-data databases backups

Configure Web Server: Set up your web server to point its document root to the public/ directory within the chosen handler's path (e.g., sqlite_json_handler/public/).
(SOAP Only) Configure the WSDL: Update the <soap:address location="..."> in public/database_service.wsdl to point to your correct soap_server.php URL.

Usage

Usage instructions, including request/response formats and code samples for interacting with the APIs, are available in their respective documentation files:

JSON/REST API: JSON/REST API Usage Guide
SOAP API: SOAP API Usage Guide

Contributing

Contributions are welcome! If you'd like to contribute, please follow these steps:

Fork the repository.
Create a new branch (git checkout -b feature/your-feature-name).
Make your changes.
Commit your changes (git commit -m 'Add some feature').
Push to the branch (git push origin feature/your-feature-name).
Open a Pull Request.

Please ensure your code adheres to PSR standards where applicable and includes appropriate tests if new functionality is added.

Support iQuipe Digital

If you find this project useful and would like to support its development, please consider making a donation. Your support helps maintain and improve this project, as well as develop new open-source tools.

Donate via flutterwave: https://flutterwave.com/donate/dbgpvvba1dxi
Donate via Buy Me A Coffee: https://www.buymeacoffee.com/YourBMCPage (Replace YourBMCPage or add other platforms if you prefer)

Every contribution, no matter the size, is highly appreciated!

License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details (you'll need to create this file).

We hope this SQLite API Handler streamlines your database interactions! For any inquiries or issues, please contact iQuipe Digital at iqcloud@outlook.com.

iquipedigital / sqlite-json-handler

Maintainers