CONTRIBUTION.md

March 8, 2024 · View on GitHub

Requisitos previos

Antes de comenzar a desarrollar este proyecto, asegúrese de tener instalados los siguientes SDK y software. Preste mucha atención a las versiones especificadas para evitar problemas de compatibilidad. Algunas versiones pueden funcionar, pero se recomiendan las que se enumeran a continuación.

Node v20.9.0
Go 1.21.1
Git Bash(for Windows)
- Necesito seleccionar
Visual Studio Code

Antes de modificar el código fuente, debe leer las secciones siguientes para conocer la arquitectura y los detalles técnicos.

¿Cómo lanzar un proyecto?

Para evitar escribir partes duplicadas, lea README.md sobre esta sección, incluye una guía completa sobre cómo instalar deps y ejecutar proyectos frontend y backend.

¿Cómo construir un proyecto?

We fully opened the source project of this project, to build this project, you can trigger below commands in Git-Bash:

./pipeline/build-all.sh

Extensiones VSCode para desarrolladores

Si vas a desarrollar este proyecto, aquí tienes algunas extensiones increíbles que puedes comprobar y que podrían resultar útiles. Tenga en cuenta que esta sección seguramente no tiene ningún interés.

Prettier - Code formatter
TODO Highlight
React
Go
Golang Tools
Tailwind CSS IntelliSense
Nano ID generator
HTML CSS Support
Go To Method
go snippets
Go Outliner
Go Asm
Go Doc

Desarrollo y compilación en VSCode

Si va a desarrollar o crear este proyecto, tenga en cuenta que primero debe completar los pasos siguientes; de lo contrario, recibirá errores sin excepción.

Configure la ruta de ejecución de su terminal como Git Bash
Establece un entorno en tu sistema: LAFTOOLS_ROOT=${Your Actual Project Root}.
Instale dlv y gopls para el servicio backend de Go cuando lo inicie por primera vez.

Tecnologías

Para comenzar a desarrollar, verifique si está familiarizado con las tecnologías que utilizamos. No es necesario aprenderlos todos si no, está bien si solo está familiarizado con las tecnologías F/E o B/E, tenemos pruebas unitarias y flujo de trabajo de solicitud de extracción para garantizar que sus cambios se realicen correctamente.

Esperamos su contribución.

Para desarrollo front-end:

React
TypeScript
BluePrint.js
Tailwind.css

Para desarrollo back-end:

Go
Node.js

Para desarrollo de escritorio/cliente:

Wails.io
Electron
Browser Extension

Para escribir nuestros documentos de manera concisa, no detallaremos todos los detalles sobre esa tercera biblioteca aquí; lea el código fuente para obtener más detalles.

Architecture

TODO:

Client (Web, Desktop, IDE Plugin) Server SIde Go Server Side Node

Specifications

Tools Implementation

To make sure all tools are supported on all UI clients (Web, Desktop, IDE, mobile, etc…), it is recommended that we implement the logic of tools on the server side, not the client side.

For instance, if you want to convert a base64 text into plain text, we should always do the conversion on the Go server side although there’s a quicker way to do it in the browser directly, which takes user experiences and tool compatibility into consideration.

Node Module Design

You probably noticed there’s a Node.js server module in the architecture. Why should we use Node.js in this software, isn’t it eating our memory? Aren’t we are we pursuing low memory usage?

The reason why we bring Node worker is to :

Utilize the ecosystem for extra tools logic in Node.js
Define system menus, extensions, and config dynamically.
Develop extensions without restarting the Go service.

To avoid the Node worker keeps eating u machine’s memory, we adopt the below strategy:

Run Node as a sub-process in Go.
Only run it when there’s a necessity.
Using WebSocket as the protocol between Go and Node.
Terminate Node if there’s no new request for it.

For instance, when you click a button to beautify a piece of code, the client will send a request to the server side. Note that the server side is the Go service.

Then, the Go service receives and detects this request depending on the Node service, accordingly, it will:

Check if Node is still alive.
If not then just launch it and keep waiting until Node is active.
Publish a job to the node worker.
Waiting for the response from the Node worker.

Once the Node worker completes the process, it will return the data to Go(service) via WebSocket protocol.

Code Style

To have a good software quality and strong international support, please follow the code styles as below:

Any label, text or message in front-end or back-end project that will be visible to users should be wrriten in English, and be wrapped by Dot function. (Learn more in i18n setup).
Any comment for your changes should also be written in English.
Consider performance and extensibility in your code.

About i18n Config

Please ensure all text is written in English, for instance:

// "leVsK" -> fragment id
// "This is a {0} project, I like {1}" -> main text
// "awesome" -> {0}
// "LafTools" -> {1}
let str: string = Dot("leVsK","This is an {0} project, I like {1}","awesome","LafTools")

console.log(str) // This is an awesome project, I like LafTools

Next Chapter

Great! You’ve learned the architecture and basic technical detail about this project.

Now, you can click below sections to learn more if you’re still interested.

How to translate texts by using i18n config?
How to develop and build for front-end project?
How to develop and build for back-end project?
How to write my extension?
How to run unit tests?
How to build the binary from source code?

For sure, there's also a FAQ link for your reference.

Lastly, we appreciate that you want to contribute to this project. Should you had any issues or bewilderments, feel free to contact us via Github issue at any time.

Thanks and Regards,
Laftools Team