neoan3/neoan3

official neoan3 cli


README

Build Status Maintainability neoan3 Discord

Automate your neoan3 needs

  1. Requirements
  2. Installation
  3. Creating new ...
    1. app
    2. component
    3. frame
    4. model
  4. Reusing components/frames/models
  5. Handling credentials
  6. Database migration
  7. Publishing components/frames/models to be reused
  8. File creation templating
  9. Development server
  10. Reporting issues
  11. Collaboration

Requires

  • PHP
  • composer
  • GIT

Installation

composer global require neoan3/neoan3

Starting a new neoan3 application

  1. create a new folder and navigate into it

    e.g. mkdir myApp

    cd myApp

  2. run neoan3 new app command

    e.g. neoan3 new app myApp

  3. run in your local webserver

Note: The last parameter (e.g. myApp) should be the web-folder the app is run under. If you are running the instance on the root, please omit the last parameter. Deployment: It is likely that you will have to change the .htaccess (when running Apache) for your deployment target. In most cases, changing the RewriteBase should be enough.

new component

neoan3 new component [component-name]

This command will guide you through the creation of a new component, prefilling the controller according to your choices.

  • api (generates get & post functions using a particular frame)
  • route (generates init-functions resulting in the component acting as a valid route)
  • custom element (currently empty class)

new frame

neoan3 new frame [frame-name]

This command generates a new frame.

new model

neoan3 new model [model-name]

This command creates a new model.

install (not yet implemented)

neoan3 install [url]

This command executes external installation scripts in cases where composer cannot. In most cases you want to use "add" instead of "install" to ensure proper collaboration. This command is normally used to simplify installation of 3rd party applications.

add

neoan3 add [destination] [package] ([repository-endpoint])

Adding components makes the following assumptions:

  • the component is registered as a composer-package
  • it is either targeted at being a frame, a model or a component

for all other packages, please use the respective package manager (e.g. composer or npm) or version control system (e.g. GIT).

neoan3 apps are "regular" composer packages. Please include them using composer require

example

neoan3 add frame neoan3-frame/kit

You can also add the repository-endpoint parameter if you have private repositories or want to work without publishing to packagist. Please include the full url in these cases.

works with bitbucket & github

example

neoan3 add model custom-model/products https://github.com/yourName/yourPackage.git

Please note that the name (here: custom-model/products) must be the name as specified in your composer.json of the neoan3-entity. See publish.

credentials & variables

It is recommended to store static credentials (like smtp, API-tokens etc) outside the web root. This command attempts to mange such credentials in a folder "credentials" and a file credentials.json

neoan3 credentials

In its most simplistic form, a neoan3 implementation could look like this (in a frame):

$credentials = getCredentials();
// e.g. sendgrid
$sendgridCredentials = $credentials['sendgrid'];

NOTE

By default the cli tries to work with a folder "credentials" in the root of your current drive. You can influence this behavior by setting it to another location e.g.

neoan3 set credential-path /home/myUser

Remember to pass in the same path within your neoan3 project when calling the global function getCredentials($path).

migrate

Currently supports SQL only.

neoan3 migrate models [direction]

migrate down

neoan3 migrate models down

This generates migrate.jsons from the connected database structure. The following assumptions are made:

Tables starting with a particular model-name are associated with that model. Example: If a model "user" exists tables starting with "user" are considered. This would include table-names like "user", "user_password" or "userEmail". The recommended way for neoan3 is to follow a snake_case naming for tables and columns.

migrate up

neoan3 migrate models up

This creates or alters tables in your connected database based on structural declarations present in your migrate.json files in the folder of models. It is important to know that removing a column in your declaration will NOT remove the column from the database, while adding a column will generate the column in your database.

publish (not yet implemented)

publish [entity-type] [entity-name]

example

publish model user

The publish-command transforms a local neoan3 entity into a composer package. Dependencies are taken care of automatically. The command will also ask you whether you directly want to publish on github. To do so, please ensure:

  • you have git installed
  • you have registered you identity (config)
  • you have a valid token for the intended username
  • created a remote repository (e.g. via github.com)

Please refer to Git documentation in order to achieve the above.

Since you have a valid composer.json in your repository now, you may publish on packagist as well.

Templates

You can influence the generated output with templates. To do so, place a folder _template in your project. Basic variable support works with double curly braces without spaces ( {{name}} ) The following files are respected:

Casing: By default variables are translated to PascalCase. Depending on your needs, you have the following possibilities for your casing:

Development server shortcut

Running neoan3 develop will start the built-in PHP server using the provided router-script.

Reporting issues

The GitHub repo neoan3-cli is actively maintained. Please report issues there.

Collaborators wanted

Over 10.000 neoan3 applications are waiting for documentation. I'd love to have some people to help me:

  • document neoan3 (framework)
  • document neoan3-cli
  • document various neoan3 composer apps
  • create tutorials

If you are interested, please fel free to get in touch @ https://github.com/sroehrl

Contributors

sroehrl