Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/archeopternix/crudgen

Generator for a CRUD application with echo frontend and pluggable storage backends
https://github.com/archeopternix/crudgen

Last synced: about 1 month ago
JSON representation

Generator for a CRUD application with echo frontend and pluggable storage backends

Host: GitHub
URL: https://github.com/archeopternix/crudgen
Owner: archeopternix
License: apache-2.0
Created: 2020-12-14T09:21:18.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2023-03-14T10:08:14.000Z (almost 2 years ago)
Last Synced: 2024-10-16T19:34:51.292Z (3 months ago)
Language: Go
Size: 122 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# CRUDgen
Generator for a web based CRUD application/API with selectable frontends and backends.

The arget is to create a full (web based) CRUD application that is generated using templates 'go/template'.
Such an application consists of frontends (view components or API's) and backends (repositories like MOCK or SQL databases).
These modules are organized in a different [CRUDgen modules](https://github.com/archeopternix/crudgen-modules) repository that will be loaded dynamically upon code generation
It is even possible to write own frontend or backend adapters

CRUDgen uses an [AST](https://github.com/archeopternix/crudgen/tree/main/ast) (abstract syntax tree) that is backed up by a configuration files in YAML.
You will be provided with an interactive command line interface that helps you building up the
model which is the foundation for the code generation.

CRUDgen provides
* Easy subcommand-based CLIs: crudgen run, crudgen add entity, etc.
* Fully POSIX-compliant flags (including short & long versions)
* Nested subcommands
* Easy generation of applications & commands with cobra init appname & cobra add cmdname
* Automatic help flag recognition of -h, --help, etc.
* Pluggable modules stored in a separate repository

# Installing
Using CRUDgen is easy. First, use `go get` to install the latest version
of the library. This command will install the `crudgen` generator executable
along with the library and its dependencies:

go get github.com/archeopternix/crudgen

## Command line interface CLI:

CRUDgen CLI is built on a structure of commands, arguments & flags.

**Commands** represent actions, **Args** are things and **Flags** are modifiers for those actions.

The best applications read like sentences when used, and as a result, users
intuitively know how to interact with them.

The pattern to follow is
`crudgen VERB NOUN --ADJECTIVE.`
or
`crudgen COMMAND ARG --FLAG`

## Commands

### Initialisation
Basic setup of the AST configuration in the target directory.
Configuration files will be created with default data set.

Usage:
crudgen init [flags]

Flags:
-n, --name string name of the application
-h, --help help for init
--cfgfile string filename for config files (default ".crudgen")
--cfgpath string path to config files (default "./config/")
--module-path string path where the modules are stored (default "./modules/")
--module-pkg string crudgen modules package in github.com (default "https://github.com/archeopternix/crudgen-modules.git")

### run
The application will be generated (generate all) and the main() will be executed.
If there is a webserver needed the option flag port could be used.

Usage:
crudgen run [flags]

Flags:
-h, --help help for run
--port int16 Port to be used by webserver (default 8080)

### add command group
These are the commands that can be utilized to add, relations, entities and fields:

Usage:
crudgen add [command] [flags]

Available Commands:
entity adds an entity to the application
relation adds an entity relation to the application

boolean boolean field added to an entity
email e-mail field added to an entity
integer integer field added to an entity
longtext longtext field added to an entity
lookup lookup field added to an entity
number number field added to an entity
password password field added to an entity
phone phone field added to an entity
text text field added to an entity

### generate command group
Generates part or the full application, means there will be all necessary files
created (copy or by template execution)

Usage:
crudgen generate [flags]
crudgen generate [command]

Available Commands:
all generates the full application
core generates the core components
model generates the model structs
repository repository for data storage
view view components will be generated

## Arguments for add command

### Adding an entity
An entity will be added to the configuration. The default type is a
normal 'entity' that holds fields, it is necessary to create fields and add
them to the entity configuration.

Usage:
crudgen add entity [flags]

Flags:
-h, --help help for entity
-n, --name string name of the entity
-t, --type string type of the entity to be created (default "default")

### Adding a relation
The relation will be added to the configuration. You can choose as
relation type (e.g.) onetomany. As a flag source and target have to be submitted as
the both entitites that are in a relation to each other

Usage:
crudgen add relation [flags]

Flags:
-h, --help help for relation
-s --source string Name of the source (e.g. 1..) entity
-t --target string Name of the target (e.g. ..n) entity
--type string Type of relation (1..n = onetomany) (default "onetomany")

### Adding a text field (text)
Adds a text field to an entity where you can set if the field is --required
or used as a --label in drop down select boxes and define the maximum length.
Length=-1 means no restriction

Usage:
crudgen add text [flags]

Flags:
-e, --entity string Entity where the field will be added
-h, --help help for fieldtext
--label This field will be used as a label for drop down fields (to activate: --label)
-l, --length int Maximum text length (-1 .. means no restriction) (default -1)
-n, --name string Name of the field
--required Content for field is required to be accepted (to activate: --required)

### Adding a longtext field (longtext)
Adds a longtext field to an entity where you can set if the field is --required
and define the maximum length. Length=-1 means no restriction

Usage:
crudgen add longtext [flags]

Flags:
-e, --entity string Entity where the field will be added
-h, --help help for fieldtext
-l, --length int Maximum text length (-1 .. means no restriction) (default -1)
-n, --name string Name of the field
--required Content for field is required to be accepted (to activate: --required)
--columns int Columns for textfield (default = 80) (default 80)
--rows int Rows for textfield (default = 4 (default 4)

### Adding a password field (password)
Adds a password field to an entity where you can set if the field is --required
and define the maximum length. Length=-1 means no restriction

Usage:
crudgen add password [flags]

### Adding a phone field (phone)
Adds a phone field to an entity where you can set if the field is --required
and define the maximum length. Length=-1 means no restriction

Usage:
crudgen add phone [flags]

### Adding a e-mail field (email)
Adds a e-mail field to an entity where you can set if the field is --required
and define the maximum length. Length=-1 means no restriction

Usage:
crudgen add email [flags]

### Adding a boolean field (boolean)
Adds a boolean (true/false) field to an entity.

Usage:
crudgen add boolean [flags]

Flags:
-e, --entity string Entity where the field will be added
-h, --help help for fieldtext
-n, --name string Name of the field

### Adding an integer field (integer)
Adds an integer field to an entity where you can set the 'min', 'max' value
that is allowed to enter. The standard 'step' between values is 1 (means integer) but this can
be changed by setting the 'step' flag

Usage:
crudgen add integer [flags]

Flags:
-e, --entity string Entity where the field will be added
-h, --help help for fieldtext
-n, --name string Name of the field
--max int Minimum value for field ((default no maximum (default 9223372036854775807)
--min int Minimum value for field (default no minimum) (default -9223372036854775808)
--step int Step between values (step = 1 for integer) (default 1)

### Adding a number field (number)
Adds a number field to an entity. Numbers are any floating point values
Usage:
crudgen add number [flags]

Flags:
-e, --entity string Entity where the field will be added
-h, --help help for fieldtext
-n, --name string Name of the field

### Adding a lookup field (lookup)
Adds a lookup field to an entity. The name of the lookupfield needs to
be the name of the corresponding entity

Usage:
crudgen add lookup [flags]

Flags:
-e, --entity string Entity where the field will be added
-h, --help help for fieldtext
-n, --name string Name of the field

## AST tree