rog-golang-buddies / go-automatic-apps

Generate CRUD applications automatically with the least effort and as beautiful as possible

Go Automatic Apps (GAA)

Generate CRUD applications automatically with the least effort and as beautiful as possible

Discord invite link: Go Lang Buddies Discord channel: #go-automatic-apps-discussion

How Go Automatic Apps is used? (To be done)

1. Create a new Go project
2. Install Go Automatic Apps dependency
3. Define your database file (schema name and connection parameters)
4. Define your table models (using ent.io)
5. Instantiate Go Automatic Apps server
6. Done

How it works? (To be done)

GAA CLI

Command line to execute actions:

• Create a new model
• Create migrations
• Run migrations

GAA Server

The server that handles the CRUD UI (React) and the API.

The server does it automatically by reading the models definitions.

1. Autogenerated UI for Create/Read/Update/Delete (CRUD) rows from a model
2. Autogenerated API to respond to the UI actions

Contribute

Setup

• Go 1.19

Folders

• architecture: Documents and diagrams
• cmd: Code for the gaa command
• pkg: Exportable libraries
• internal: Utility functions
• server: Server side code

go-automatic-apps's Issues

[server] Query model rows using form

Read the list of available models with ent

Investigate how to use `ent` from gaa CLI

Where the files will be located in the project?

https://entgo.io/docs/schema-def

How do we run the migrations?

https://entgo.io/docs/migrate

[react] Create a form for a model automatically

Given the data structure information in the UI, we can generate a form automatically.

The form will show a line per field and the appropriate component for editing the data.

Data types:

• string - input
• bool - checkbox
• date - date selector
• number - input
• etc...

[server] Add pagination parameters to routes.CreateGetModelRows

use limit and offset parameters to paginate the query

[UI] Get models list from /models page

Update Makefile to run the "gaa" command line with parameters

[server] Graceful shutdown

Listen for SIGTERM signal.
Set a timeout duration.
When SIGTERM signal is received wait for both http and grpc servers to shutdown gracefully (both of them have a method for this).
If shutdown operations exceeds timeout duration forcefully close the servers.
Exit program.

[server] static routes are not working

[server] compress responses with chi middleware

Configure chi or http server to compress the HTTP traffic.

[server] GORM to sqlx?

Anarchy0904 proposed to make this change.

@jordiburgos I saw discussions about the ORM and GORM being one possibility. We have been using GORM in our project from more than a year now. One major problem with it is that in the query conditions you refer to the database schema fields and no the Go struct fields which creates dependency outside the control of the code.
As much as I prefer ORM for Rest APIs and CRUD intensive application at this point I would suggest something like sqlx that helps in the hydration and not building too much dependency on a third library also building exactly what is required instead.

[LIB] Start the server

Create a command to start a new web server.

As a starting point, return a simple index.html

Define how CLI commands are defined

Use any library from Go to parse the command line and decide what to do.

This task is just to show how the command line works and does not require to code the commands. Printing the options is enough.

Commands:

$ gaa model migrate
$ gaa model create User
$ gaa server -P 8080

[react] Show rows data in a table

[react] Use returned data types to format table columns

[CLI] Generate CLI executable

Build the project to generate an executable for Windows, Linux, Mac.

(Builds for other operating systems might be useful too, but not required yet)

Executable name: "gaa" or "gaa.exe"

[server] update to Go 1.19

Update the build files, and project configuration files.

[gRPC] Create an endpoint to get tables list

As this is the first [gRPC] task, it is needed to configure gRPC in the project.

Then, create an endpoint to return the list of tables, with its field list with types.
This info is already available coming from ent

Hook the internal/parser/parse_cli.go with cmd/main.go

Use internal/parser/parse_cli.go in cmd/main.go to route the to different functions of the application depending on the commands and flags.

[UI] Show the rows of a model in a page

URL: /models/<model_name>

Shows a table with all the data from a model.
The table has a column for each field of the model.

The data and column names come from a REST endpoint.

Investigate whether we should use gRPC or traditional REST

gRPC is a new way of creating backends that effectively allows you to simply call a "function" that is like a traditional REST call

More information on it can be found here Quick start guide

A huge benefit to gRPC is the speed compared to traditional REST. It also would still allow us to use a rest gateway to still have a rest api layer when the service is running. This imo is the best of both worlds as it allows for speed for those who want to use gRPC but still has the convenience of REST if you are just doing something quick

protoc build error

I get this error on make protoc. I am working on Windows, and I already installed the protoc executable.

protoc version: protoc-21.4-win64

@segfault99 do you have any idea about this?

PS C:\workspace\go-automatic-apps> make protoc
protoc -I=./proto --go_out=. --go-grpc_out=. ./proto/*.proto
'protoc-gen-go-grpc' is not recognized as an internal or external command,
operable program or batch file.
--go-grpc_out: protoc-gen-go-grpc: Plugin failed with status code 1.
make: *** [Makefile:40: protoc] Error 1

[server] Create a list all rows endpoint

Create an endpoint to return all the data from a model.
The model name is a parameter.

[UI] Create a page to show the list of models

URL: /models

The page shows the list of models coming from the gRPC endpoint.
Clicking on a model goes to the /models/<model_name> page

[CLI Command][UI] Enhance the serve command with React

Enhance the "serve" command by returning a scaffold React application.

This should be served from index.ts or index.tsx instead of the previous index.html

Does the build of the UI app have to be done in a previous step? Done by the cli?

This might help: https://www.fareez.info/blog/embedding-react-app-in-go-binary/

[server] Create a REST endpoint to store data into the database

Create a REST endpoint to create a row in the database from the UI.

Create a row:
POST /api/models//

Update a row:
PUT /api/models//

Steps:

1. Receive data
2. Find the appropriate moddl
3. Create object
4. Store in the database using GORM

Project logo and favicon.ico design

Design a logo for the project.

Then, create a favicon.ico file for the web server.

[gRPC] Remove gRPC and use REST

I am investigating how to call gRPC from the browser and it takes too much work from several different libraries.

The setup requires a wrapper for Go's http server object. Then 2 build steps to generate the JavaScript code and TypeScript definitions. And make it all work...

I prefer to move to REST as gRPC is not really ready for the browser.

Any ideas?