EinarCLI is a blazingly fast 🔥 and powerful command-line interface tool designed to supercharge 🚀 your application development process. It helps to streamline and expedite the creation of your applications, enabling you to code faster, smoother, and smarter.
With EinarCLI, get ready to turn up the heat 🔥 on your programming skills and develop applications like never before!
To install EinarCLI, use the following command:
go install github.com/Ignaciojeria/einar@v1.35.0
To verify your EinarCLI installation, run:
einar version
To use the official EinarCLI template for creating a new project, execute the following command:
einar init my-project-name https://github.com/Ignaciojeria/einar-cli-template no-auth
If you wish to utilize your own corporate private template to initiate a new project, use the following command:
einar init my-project-name https://github.com/your-corporative-private-einar-cli-template user:token
We are using Echo to manage HTTP requests efficiently. To install the Echo Server, run the following command in your terminal:
einar install echo-server
To check the port that your HTTP server is using for your application, you can refer to the .env file located in the root directory of your Einar project:
# THIS IS REFERENCE FILE OF YOUR ENVIRONMENT VARIABLES
# DONT STORE YOUR ENVIRONMENT VARIABLES ON YOUR REPOSITORY!
PORT = "8080"
COUNTRY = "CL"
PROJECT_NAME = "my-project-name"
ENVIRONMENT = "local"To run the application, you can start it as a traditional Golang application by executing the following command:
go run main.go
This will start your application on the default port specified in the configuration.
To check the status of the running application, visit the following URL in your web browser:
An HTTP Inbound Adapter is the same as a controller in a web application. To create a new HTTP inbound adapter, we need to execute the following commands:
einar generate get-controller get-customer
einar generate post-controller post-customer
einar generate put-controller put-customer
einar generate patch-controller patch-customer
einar generate delete-controller delete-customer
When running the Einar commands to generate controllers, the following directory structure will be created in your project:
/app
/adapter
/in
/controller
- get_customer.go # Generated with 'einar generate get-controller get-customer'
- post_customer.go # Generated with 'einar generate post-controller post-customer'
- put_customer.go # Generated with 'einar generate put-controller put-customer'
- patch_customer.go # Generated with 'einar generate patch-controller patch-customer'
- delete_customer.go # Generated with 'einar generate delete-controller delete-customer'For example, when you generate a controller using the einar generate get-controller get-customer command, Einar CLI will create a new .go file with the following structure:
package controller
func init() {
container.InjectInboundAdapter(func() error {
einar.Echo.GET("/INSERT_YOUR_PATTERN_HERE", getCustomer)
return nil
})
}
func getCustomer(c echo.Context) error {
//PUT HERE YOUR HANDLING PROCESS
return c.JSON(http.StatusOK, "INSERT_YOUR_CUSTOM_RESPONSE")
}In the generated controller template:
-
"/INSERT_YOUR_PATTERN_HERE"is a placeholder for your route pattern. Replace this with the actual endpoint pattern for your route (for example,"/customer"for a route that handles customer data). -
getCustomeris the function that handles the route. It currently includes a placeholder comment,//PUT HERE YOUR HANDLING PROCESS. Replace this comment with the actual logic that should be executed when a request is made to this route. -
"INSERT_YOUR_CUSTOM_RESPONSE"is a placeholder for the response that your route will return. Replace this with the actual response that you want to send back to the client.
Remember to adjust these placeholders according to your project's needs.
For more information on the Echo framework, visit the Echo documentation.
To install PubSub Client, run the following command in your terminal:
einar install pubsub
After installing Pub/Sub, when you run the application, it will ask you for valid Google application credentials and project ID to start working with Google Pub/Sub.
Make sure to allocate the following configuration in the .env file located at the root of your project:
#ENABLE FOR PUBSUB OR FIRESTORE ARCHETYPE INSTALLATION
GOOGLE_PROJECT_ID = "gcp-project-id"
#optional and only if you are working with a service account
GOOGLE_APPLICATION_CREDENTIALS = "path/of/your/optional/serviceAccount.json"Creating a new Google PubSub Inbound Adapter, in our case, involves generating a pull subscription to a topic. This can be done by executing the following command:
einar generate subscription pull-customer-created
/app
/adapter
/in
/subscription
- pull_customer_created.go # Generated with 'einar generate subscription pull-customer-created'For example, when you generate a subscription using the einar generate subscription pull-customer-created command, Einar CLI will create a new .go file with the following structure:
package subscription
import (
"context"
"encoding/json"
"my-project-name/app/exception"
"my-project-name/app/shared/archetype/container"
einar "my-project-name/app/shared/archetype/pubsub"
"my-project-name/app/shared/archetype/pubsub/subscription"
"my-project-name/app/shared/constants"
"cloud.google.com/go/pubsub"
)
var pullCustomerCreated = func(ctx context.Context, subscriptionName string, m *pubsub.Message) (err error) {
var dataModel interface{}
defer subscription.HandleMessageAcknowledgement(ctx, &subscription.HandleMessageAcknowledgementDetails{
SubscriptionName: subscriptionName,
Error: err,
Message: m,
ErrorsRequiringNack: []error{
exception.INTERNAL_SERVER_ERROR,
},
CustomLogFields: map[string]interface{}{
"dataModel": dataModel,
},
})
if err := json.Unmarshal(m.Data, &dataModel); err != nil {
return err
}
return nil
}
var pullCustomerCreatedConfig = func() error {
var subscriptionName = "INSERT YOUR SUBSCRIPTION NAME"
subRef := einar.Client().Subscription(subscriptionName)
subRef.ReceiveSettings.MaxOutstandingMessages = 5
settings := subRef.Receive
go subscription.
New(subscriptionName, pullCustomerCreated, settings).
WithPushHandler(constants.DefaultPushHandlerPrefix + subscriptionName).
Start()
return nil
}
var _ = container.InjectInboundAdapter(pullCustomerCreatedConfig)Creating a new Google PubSub Outbound Adapter, in our case, involves generating a publisher that sends messages to a Google Cloud topic. This can be done by executing the following command:
einar generate publisher publish-customer
/app
/adapter
/out
/publisher
- publish_customer.go # Generated with 'einar generate publisher publish-customer'For example, when you generate a publisher using the einar generate publisher publish-customer command, Einar CLI will create a new .go files with the following structure:
package pubsub
import (
"my-project-name/app/exception"
"my-project-name/app/shared/archetype/pubsub/topic"
"my-project-name/app/shared/archetype/slog"
"my-project-name/app/shared/constants"
"context"
"encoding/json"
"cloud.google.com/go/pubsub"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/codes"
"go.opentelemetry.io/otel/trace"
)
var PublishCustomer = func(ctx context.Context, REPLACE_BY_YOUR_DOMAIN map[string]string) (err error) {
topicName := "INSERT YOUR TOPIC NAME HERE"
_, span := topic.Tracer.Start(ctx, "PublishCustomer",
trace.WithAttributes(attribute.String(constants.TopicName, topicName)),
)
defer span.End()
bytes, err := json.Marshal(REPLACE_BY_YOUR_DOMAIN)
if err != nil {
return err
}
message := &pubsub.Message{
Attributes: map[string]string{
"customAttribute1": "attr1",
"customAttribute2": "attr2",
},
Data: bytes,
}
result := topic.Get(topicName).Publish(ctx, message)
// Get the server-generated message ID.
messageID, err := result.Get(ctx)
if err != nil {
span.SetStatus(codes.Error, err.Error())
span.RecordError(err)
slog.
SpanLogger(span).
Error(exception.PUBSUB_BROKER_ERROR.Error(),
constants.Error, err.Error())
return exception.PUBSUB_BROKER_ERROR
}
// Successful publishing
return nil
}To install Firestore Client, run the following command in your terminal:
einar install firestore
After installing Firestore, when you run the application, it will ask you for valid Google application credentials and project ID to start working with Firestore.
Make sure to allocate the following configuration in the .env file located at the root of your project:
#ENABLE FOR PUBSUB OR FIRESTORE ARCHETYPE INSTALLATION
GOOGLE_PROJECT_ID = "gcp-project-id"
#optional and only if you are working with a service account
GOOGLE_APPLICATION_CREDENTIALS = "path/of/your/optional/serviceAccount.json"Creating a new Google Firestore Outbound Adapter, in our case, involves generating a repository that does database operations to a specific firestore collection. This can be done by executing the following command:
einar generate firestore-repository save-customer
/app
/adapter
/out
/firestore
- save_customer.go # Generated with 'einar generate firestore-repository save-customer'For example, when you generate a repository using the einar generate firestore-repository save-customer command, Einar CLI will create a new .go files with the following structure:
package firestore
import (
"archetype/app/domain/ports/out"
einar "archetype/app/shared/archetype/firestore"
"context"
"cloud.google.com/go/firestore"
)
var SaveCustomer = func(ctx context.Context, REPLACE_BY_YOUR_DOMAIN map[string]string) error {
// einar.Collection("INSERT_YOUR_COLLECTION_CONSTANT_HERE") returns an instance of *firestore.CollectionRef type.
// For more details, please consult the documentation here: https://firebase.google.com/docs/firestore/quickstart?hl=es-419#go
var _ *firestore.CollectionRef = einar.Collection("INSERT_YOUR_COLLECTION_CONSTANT_HERE")
return nil
}🔧 Core Concepts:
- No Hidden Dependencies: Ensures transparency in the code dependencies.
- Dependency Container: Manages object instances and dependencies.
- Inversion of Control: Decouples modules and promotes code flexibility.
📡 Google PubSub Integration:
- Client Installation & Setup: Streamlines the setup process for Google PubSub.
- Subscriptions Generation: Easily generate subscriptions.
- Battle-tested automatic pull subscription reinitialization when the signal is broken.
- Publishers Generation: Quickly set up publishers for message distribution.
- Avoid the common mistake of creating many topic instances when you use them to publish events by default.
🌐 Echo Server Integration:
- Echo Server Installation: Simplifies the installation process of the Echo Server.
- Controllers Generation: Generates controllers for handling HTTP requests.
🔥 Google Firestore Integration:
- Firestore Installation & Setup: Streamlines Firestore database setup.
- Repositories Generation: Quickly generate repositories.
👨💻 Code Ownership and Control:
- Full Control of Generated Code: You have complete control over the code that is generated.
- Code Ownership: The generated code is yours to keep and use as you wish.
(Contact and support information here)
(Contribution guidelines here)
- Implement template repository tags for backward compatibility and stability (DONE)
- Automatic template pulling for existing public einar projects (DONE)
- Remove ports to avoid early Abstraction (DONE)
- Imrpove template tags cli detection for backward compatibility with projects using older versions (DONE)
- OpenTelemetry support for all components (DONE)
- Check Jaeger open telemetry integration (DONE)
- Check Datadog open telemtry integration (DONE)
- TraceProviderFabric for datadog trace provider and google trace provider.
- Unit Testing
- Integration Testing
- Documentation WebSite
- Contribution GuideLines
- secret-manager installation
- secret management repository template
- embedded nats-server (IN TESTING)
- cloud run cicd deployment installation
- implement and test cloud run open telemetry collector sidecar https://cloud.google.com/blog/products/serverless/cloud-run-now-supports-multi-container-deployments
- gitpod button to init faster