Hackware Web Services

Felix Freeman 53af4521b9 Code coverage for phpunit tests 10 months ago
bootstrap 8cb57fd1e0 One testing environment to rule them all 10 months ago
config 6bb723527b CORS support 1 year ago
public ea18127941 Initial commit. Core, Wallet, Payment and Seeds. 1 year ago
.env.example 7adc24b9d9 WALLET_REMIND_DUE env var 1 year ago
.env.testing 8cb57fd1e0 One testing environment to rule them all 10 months ago
.gitignore 53af4521b9 Code coverage for phpunit tests 10 months ago
GPL-3.0-or-later.LICENSE ea18127941 Initial commit. Core, Wallet, Payment and Seeds. 1 year ago
MIT-0.LICENSE ea18127941 Initial commit. Core, Wallet, Payment and Seeds. 1 year ago
README.md 53af4521b9 Code coverage for phpunit tests 10 months ago
artisan ea18127941 Initial commit. Core, Wallet, Payment and Seeds. 1 year ago
composer.json 53af4521b9 Code coverage for phpunit tests 10 months ago
phpunit.xml.dist 53af4521b9 Code coverage for phpunit tests 10 months ago

README.md

Hackware Web Services

Description

Hackware Web Services or "Hawese" is a modular web API which returns JSON responses.

Its structure is based on Laravel/Lumen 5.8+ packages. It can be mounted as a monolithical web service or as various microservices depeding on how you structure your composer.json.

Features (packages)

  • Core: Lightweight base class for table based models, standardized JSON responses and User model.
  • Wallet: Digital wallet that associates transactions and balance to unique users.
  • Payment: Payment through various payment gateways. Currently Khipu and Flow.

How to pronounce Hawese?

You can pronounce it as "how easy".

Run it

Requirements

Please refer to the requirements of each package. Basically the same as of Lumen/Laravel 5.8+ and composer.

Installation

  1. composer require hackware/hawese
  2. Setup your environment variables based on the .env.example file. It will load .env.APP_ENV if you set the APP_ENV environment variable beforehand. Elsewhere it will load the .env file.
  3. Run from the public/ path.

Find detailed documentation and configuration options in each project.

Tests

If you are developing Hawese run tests with composer test or composer test-coverage.

Add directories for your project tests as testsuite on phpunit.xml.dist and to its whitelist for coverage analysis.

Copyright and licensing

Copyright 2019 Hackware SpA.

This project license defaults to GPL 3.0 or later. It is required since it links to the following AGPL licensed projects:

  • hackware/hawese-wallet
  • hackware/hawese-payment

If you remove that dependencies in the composer.json file then you can choose to use the MIT-0 license terms.

The core library hackware/hawese-core is released under the terms of the MIT license. Non listed dependencies are released under permisive licenses too.

I will greatly appreaciate your contributions back. Please free your software too.