Skip to content

Latest commit

 

History

History
165 lines (109 loc) · 6.46 KB

CONTRIBUTION.md

File metadata and controls

165 lines (109 loc) · 6.46 KB
Raw

Note: Cette page est générée à partir de LafTools en interne.
English | 简体中文 | 繁體中文 | Deutsch | Español | Français | 日本語 | 한국어 | More

Conditions préalables

Avant de commencer à développer ce projet, assurez-vous que les SDK et logiciels suivants sont installés. Portez une attention particulière aux versions spécifiées pour éviter tout problème de compatibilité. Certaines versions peuvent fonctionner, mais celles répertoriées ci-dessous sont recommandées.

  • Node v20.9.0
  • Go 1.21.1
  • Git Bash(for Windows)
    • Il faut sélectionner
  • Visual Studio Code

Avant de modifier le code source, vous devez lire les sections ci-dessous pour connaître l'architecture et les détails techniques.

Comment lancer un projet ?

Pour éviter d'écrire des parties en double, veuillez lire README.md à propos de cette section, elle comprend des directives complètes sur la façon d'installer des deps et d'exécuter des projets frontend et backend.

Comment construire un projet ?

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

Extensions VSCode pour les développeurs

Si vous envisagez de développer ce projet, voici quelques extensions géniales à vérifier qui pourraient être utiles. Notez que cette section n’a sûrement aucun intérêt.

  1. Prettier - Code formatter
  2. TODO Highlight
  3. React
  4. Go
  5. Golang Tools
  6. Tailwind CSS IntelliSense
  7. Nano ID generator
  8. HTML CSS Support
  9. Go To Method
  10. go snippets
  11. Go Outliner
  12. Go Asm
  13. Go Doc

Développer et construire sur VSCode

Si vous envisagez de développer ou de construire ce projet, notez que vous devez d'abord suivre les étapes ci-dessous, sinon vous recevrez des erreurs inattendues.

  1. Définissez le chemin d'exécution de votre terminal sur Git Bash
  2. Définir un environnement dans votre système: LAFTOOLS_ROOT=${Your Actual Project Root}.
  3. Installez dlv et gopls pour le service backend Go lorsque vous le lancez pour la première fois.

Les technologies

Pour commencer à développer, veuillez vérifier si vous connaissez les technologies que nous utilisons. Pas besoin de tous les apprendre sinon, ce n'est pas grave si vous n'êtes familier qu'avec les technologies F/E ou B/E, nous avons des tests unitaires et un workflow de pull request pour garantir que vos modifications sont effectuées correctement.

Nous attendons avec impatience votre contribution.

Pour le développement front-end:

  • React
  • TypeScript
  • BluePrint.js
  • Tailwind.css

Pour le développement back-end:

  • Go
  • Node.js

Pour le développement de postes de travail/clients:

  • Wails.io
  • Electron
  • Browser Extension

Pour rédiger notre documentation de manière concise, nous n'allons pas détailler ici tous les détails de cette troisième bibliothèque, veuillez lire le code source pour plus de détails.

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