README

Phase 1: meanwhile, phase 2 is in production

Content Enablement Platform

Stateles (JWT) hybrid (frontend & headless) CMS built with

PHP ( neoan3 )
MySQL
Vue (administration & optional frontend)
Bulma (administration & optional frontend)

Requirements

PHP7

composer

nodeJS & npm

neoan3-cli

Installation

For usage & production

composer create-project blua-blue/blua-blue -s beta
Create Credentials (neoan3 credentials)
neoan3 migrate models up

Collaborators/developers

Download/clone/fork the repository @ https://github.com/blua-blue/blua-blue

Change the "RewriteBase" in the .htaccess file (or create a route-script for Nginx)
Run composer install
Run npm install
Create Credentials (neoan3 credentials)
Run neoan3 migrate models up

Credentials

Credentials are expected to be in a folder "credentials" outside the web-root. You can use the command neoan3 credentials for generating the following properties. Please make changes to the neoan frame (frame/neoan/Neoan.php) in order to provide credentials for:

neoan3-apps/db https://github.com/sroehrl/neoan3-db

neoan3-apps/stateless https://github.com/sroehrl/neoan3-stateless

phpmailer https://github.com/PHPMailer/PHPMailer

neoan3-apps/hcaptcha https://github.com/sroehrl/neoan3-hcapture

Example:

{
"blua_db": {
  "name": "your_db",
  "assumes_uuid": true,
  "password": "yourPassword",
  "user": "phpDbUser"

  },
"blua_stateless": {
  "secret": "yourSEcretKey"
  },
"blua_mail": {
  "host": "mail.example.com",
  "username": "some@example.com",
  "password": "MailSMTPpassword",
  "fromEmail": "some@example.com",
  "fromName": "Example-Admin",
  "port": "25",
  "secure": "ssl"
  },
"blua_hcaptcha": {
  "secret": "your secret",
  "siteKey": "site-key"
  }
}

Don't have access outside of the project? Alternatively, you can create a private function in the frame and set $this->credentials with an array supplying these credentials. However, be aware that when using credentials in your project, sharing the codebase becomes a security consideration.

$this->credentials = [
    'blua_db'=>[...],
    ...
]

You can also use neoan3 credentials to manage your credentials

You might have to provide additional settings depending on your services. Additional mailing-setup can be managed in the function newMail() (in the neoan-frame) and within your credentials when dealing with database-credentials. Please see the respective documentation for these packages.

License

MIT license opensource

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Built with love & neoan3?

Blua.blue is written as neoan3 components. We are currently working on integrating blua.blue in the neoan3-cli to be included with your neoan3 projects.

blua-blue / blua-blue

Maintainers

Details