diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index ee364f1..38e747e 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -70,6 +70,7 @@ const userConfig: UserConfig = { collapsed: false, items: [ { text: 'Установка', link: '/ru/complete-user-guide/installation' }, + { text: 'Info about your system', link: '/ru/complete-user-guide/info-about-system' }, { text: 'Создание нового проекта', link: '/ru/complete-user-guide/create-new-project' }, { text: 'Запуск проекта', link: '/ru/complete-user-guide/run-your-project' }, ] @@ -131,6 +132,7 @@ const userConfig: UserConfig = { collapsed: false, items: [ { text: '安装', link: '/zh_HK/complete-user-guide/installation' }, + { text: 'Info about your system', link: '/zh_HK/complete-user-guide/info-about-system' }, { text: '创建新项目', link: '/zh_HK/complete-user-guide/create-new-project' }, { text: '运行项目', link: '/zh_HK/complete-user-guide/run-your-project' }, ] @@ -192,6 +194,7 @@ const userConfig: UserConfig = { collapsed: false, items: [ { text: 'Instalación', link: '/es/complete-user-guide/installation' }, + { text: 'Info about your system', link: '/es/complete-user-guide/info-about-system' }, { text: 'Crear un nuevo proyecto', link: '/es/complete-user-guide/create-new-project' }, { text: 'Ejecute su proyecto', link: '/es/complete-user-guide/run-your-project' }, ] @@ -255,6 +258,7 @@ const userConfig: UserConfig = { collapsed: false, items: [ { text: 'Installation', link: '/complete-user-guide/installation' }, + { text: 'Info about your system', link: '/complete-user-guide/info-about-system' }, { text: 'Create a new project', link: '/complete-user-guide/create-new-project' }, { text: 'Run your project', link: '/complete-user-guide/run-your-project' }, ] @@ -262,14 +266,7 @@ const userConfig: UserConfig = { ] }, socialLinks: [ - { icon: 'github', link: 'https://github.com/gowebly/gowebly' }, - { - icon: { - svg: '' - }, - link: 'https://hub.docker.com/r/gowebly/gowebly', - ariaLabel: 'docker hub' - } + { icon: 'github', link: 'https://github.com/gowebly/gowebly' } ], footer: { message: "Gowebly CLI is 100% free and Open Source project under the Apache 2.0 license.
Official logo distributed under the Creative Commons License (CC BY-SA 4.0 International).", diff --git a/docs/complete-user-guide/create-new-project.md b/docs/complete-user-guide/create-new-project.md index cb8be22..f1a69ab 100644 --- a/docs/complete-user-guide/create-new-project.md +++ b/docs/complete-user-guide/create-new-project.md @@ -10,51 +10,16 @@ gowebly create ```bash [Go] go run github.com/gowebly/gowebly@latest create ``` - -```bash [Docker] -docker run --rm -it -v ${PWD}:${PWD} -w ${PWD} gowebly/gowebly:latest create -``` ::: -gowebly create - -## What CLI does for you? - -Every time you execute the `create` command for a project, the **Gowebly** CLI does the following under the hood: - -| Step | Description | -| :---: | ------------------------------------------------------------------------------------------------------------------ | -| **1** | **Structure of your project** | -| | CLI creates the project folders and all needed miscellaneous files | -| **2** | **The backend part of your project** | -| | CLI generates the backend files (`go.mod`, chosen Go framework files, and so on) | -| | CLI runs `go mod tidy` and `go fmt` for the first time | -| **3** | **The frontend part of your project** | -| | CLI generates the `scripts.js` file with importing the chosen reactivity library | -| | CLI generates the `styles.scss` file with minimal styles for the chosen CSS framework | -| | CLI generates the needed utility files (`package.json`, config for the chosen CSS framework, and so on) | -| | CLI runs `install` and `build` scripts from the `package.json` file with the chosen JavaScript runtime environment | +And result will be: -For visualization of the **Gowebly** CLI workflow, check the diagram: - -```mermaid -stateDiagram-v2 - Structure: Generate project structure - Backend: Prepare backend part - Frontend: Prepare frontend part - direction LR - [*] --> Structure - Structure --> Backend - Backend --> Frontend - Frontend --> [*] -``` - -## Project structure after creating +gowebly create -Typically, after running the `create` command, a created project contains the following files and folders: +Typically, the created project contains the following files and folders: ::: code-group -```bash{18,19} [Without template engines] +```bash{18,19} [Using html/template] . ├── assets │ ├── scripts.js @@ -131,4 +96,35 @@ Typically, after running the `create` command, a created project contains the fo Please do **not** edit `*_templ.go` Go files in the `./templates` folder of your project! They're auto-generated by the **Templ** CLI from `*.templ` templates. ::: +## What CLI does for you? + +Every time you execute the `create` command for a project, the **Gowebly** CLI does the following under the hood: + +| Step | Description | +| :---: | ---------------------------------------------------------------------------------------------------------------- | +| **1** | **The structure of your project** | +| | CLI creates the project folders and all needed miscellaneous files | +| **2** | **The backend part of your project** | +| | CLI generates the backend files (`go.mod`, chosen Go framework files, and so on) | +| | CLI runs `go mod tidy` and `go fmt` for the first time | +| **3** | **The frontend part of your project** | +| | CLI generates the `scripts.js` file with importing the chosen reactivity library | +| | CLI generates the `styles.scss` file with minimal styles for the chosen CSS framework | +| | CLI generates the needed utility files (`package.json`, config for the chosen CSS framework, and so on) | +| | CLI runs `install` and `build` scripts from the `package.json` file with the chosen frontend runtime environment | + +To visualize the workflow, please refer to the diagram: + +```mermaid +stateDiagram-v2 + Structure: Generate project structure + Backend: Prepare backend part + Frontend: Prepare frontend part + direction LR + [*] --> Structure + Structure --> Backend + Backend --> Frontend + Frontend --> [*] +``` + \ No newline at end of file diff --git a/docs/complete-user-guide/info-about-system.md b/docs/complete-user-guide/info-about-system.md new file mode 100644 index 0000000..a4f9050 --- /dev/null +++ b/docs/complete-user-guide/info-about-system.md @@ -0,0 +1,36 @@ +# Info about your system + +To view information about your system, execute the `doctor` command: + +::: code-group +```bash [CLI] +gowebly doctor +``` + +```bash [Go] +go run github.com/gowebly/gowebly@latest doctor +``` +::: + +And result will be: + +``` +✓ Your system information has been collected successfully! + +│ +│ Copy this information to paste into an issue ↘ +│ +│ Gowebly CLI: v2.0.1 (build with go1.21.5 on darwin/arm64) +│ +│ Go: 1.21.5 darwin/arm64 +│ Node.js version: 21.5.0 (npm 10.2.4) +│ Bun version: 1.0.21 +│ +│ Is Air tool installed? true +│ Is Templ package installed? true +│ + +✱ For more information go to the official docs: https://gowebly.org +``` + + \ No newline at end of file diff --git a/docs/complete-user-guide/installation.md b/docs/complete-user-guide/installation.md index 1af42d7..783da6f 100644 --- a/docs/complete-user-guide/installation.md +++ b/docs/complete-user-guide/installation.md @@ -12,18 +12,6 @@ Then, use the [`go install`][go_install_url] command: go install github.com/gowebly/gowebly@latest ``` -## Docker - -Feel free to using **Gowebly** CLI from our [official Docker image][docker_gowebly_image_url] and run it in the container: - -``` bash -docker pull gowebly/gowebly:latest -``` - -::: danger Limitations of the Docker image -This Docker image works **only** on the GNU/Linux systems (`amd64` or `arm64`, including WSL). -::: - ## Homebrew GNU/Linux and Apple macOS users available way to install **Gowebly** CLI via [Homebrew][other_brew_url]. diff --git a/docs/complete-user-guide/run-your-project.md b/docs/complete-user-guide/run-your-project.md index bf4a8ed..0793c2f 100644 --- a/docs/complete-user-guide/run-your-project.md +++ b/docs/complete-user-guide/run-your-project.md @@ -1,3 +1,9 @@ +--- +next: + text: 'FAQ' + link: '/faq' +--- + # Run your project To run your project in a development mode, execute the `run` command: @@ -10,27 +16,23 @@ gowebly run ```bash [Go] go run github.com/gowebly/gowebly@latest run ``` - -```bash [Docker] -docker run --rm -it -v ${PWD}:${PWD} -w ${PWD} gowebly/gowebly:latest run -``` ::: ## What CLI does for you? Every time you execute the `run` command for a project, the **Gowebly** CLI does the following under the hood: -| Step | Description | -| :---: | ------------------------------------------------------------------------ | -| **1** | **Start Air tool** | -| | CLI runs your project with live-reloading mode in a simple `air` command | -| **2** | **Live-reloading mode** | -| | Air tool builds frontend part of your project in production mode | -| | Air tool generates Go functions from `*.templ` templates, if needed | -| | Air tool builds the backend part of your project | -| | Air tool watches for changes in your project files and rebuilds them | - -For visualization of the **Gowebly** CLI workflow, check the diagram: +| Step | Description | +| :---: | ------------------------------------------------------------------------------------- | +| **1** | **Start Air tool** | +| | CLI runs your project with live-reloading mode in a simple `air -c .air.toml` command | +| **2** | **Live-reloading mode** | +| | Air tool builds frontend part of your project in production mode | +| | Air tool generates Go functions from `*.templ` templates, if needed | +| | Air tool builds the backend part of your project | +| | Air tool watches for changes in your project files and rebuilds them | + +To visualize the workflow, please refer to the diagram: ```mermaid stateDiagram-v2 diff --git a/docs/es/complete-user-guide/info-about-system.md b/docs/es/complete-user-guide/info-about-system.md new file mode 100644 index 0000000..a4f9050 --- /dev/null +++ b/docs/es/complete-user-guide/info-about-system.md @@ -0,0 +1,36 @@ +# Info about your system + +To view information about your system, execute the `doctor` command: + +::: code-group +```bash [CLI] +gowebly doctor +``` + +```bash [Go] +go run github.com/gowebly/gowebly@latest doctor +``` +::: + +And result will be: + +``` +✓ Your system information has been collected successfully! + +│ +│ Copy this information to paste into an issue ↘ +│ +│ Gowebly CLI: v2.0.1 (build with go1.21.5 on darwin/arm64) +│ +│ Go: 1.21.5 darwin/arm64 +│ Node.js version: 21.5.0 (npm 10.2.4) +│ Bun version: 1.0.21 +│ +│ Is Air tool installed? true +│ Is Templ package installed? true +│ + +✱ For more information go to the official docs: https://gowebly.org +``` + + \ No newline at end of file diff --git a/docs/es/getting-started.md b/docs/es/getting-started.md index 2dfbb74..c1aa3ba 100644 --- a/docs/es/getting-started.md +++ b/docs/es/getting-started.md @@ -19,23 +19,15 @@ Esto se muestra más claramente en el siguiente diagrama: stateDiagram-v2 direction LR Install: Instalar CLI - Init: Inicializar configuración Doctor: Ver diagnósticos Create: Crear un nuevo proyecto Run: Ejecutar proyecto - Build: Construir proyecto - Deploy: Despliegue en el servidor [*] --> Install - Install --> Init Install --> Create Install --> Doctor Doctor --> [*] - Init --> Create Create --> Run Run --> [*] - Create --> Build - Build --> Deploy - Deploy --> [*] ``` \ No newline at end of file diff --git a/docs/faq.md b/docs/faq.md index 2913481..de751c2 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,4 +1,7 @@ --- +prev: + text: 'Complete user guide' + link: '/complete-user-guide' next: text: 'Troubleshooting' link: '/troubleshooting' @@ -12,7 +15,7 @@ The most common questions that may come up when using the **Gowebly** CLI are co ## What is the right way to ask a question or report a bug? -Running the `doctor` command will give you a list of all the CLI tools that are installed on your system: +Running the `doctor` command will give you a list of all the tools you need to work properly with the **Gowebly** CLI that are installed on your system: ::: code-group ``` bash [CLI] @@ -22,10 +25,6 @@ gowebly doctor ``` bash [Go] go run github.com/gowebly/gowebly@latest doctor ``` - -``` bash [Docker] -docker run --rm -it -v ${PWD}:${PWD} -w ${PWD} gowebly/gowebly:latest doctor -``` ::: Next, open [GitHub Issues][repo_issues_url] and follow the instructions. @@ -34,33 +33,11 @@ Next, open [GitHub Issues][repo_issues_url] and follow the instructions. Don't forget to include output of the `doctor` command to the issue description! This is a very helpful information for the debugging process. ::: -## How to change the default configuration? - -You can change the default configuration in the `.gowebly.yml` file. - -Create the `.gowebly.yml` file in the root of your project: - -::: code-group -``` bash [CLI] -gowebly init -``` - -``` bash [Go] -go run github.com/gowebly/gowebly@latest init -``` - -``` bash [Docker] -docker run --rm -it -v ${PWD}:${PWD} -w ${PWD} gowebly/gowebly:latest init -``` -::: - -Change the settings to your needs and `create`, `run` or `build` your project as usual. - ## Is it possible to see a demonstration of how the CLI works without installation? -Yes, of course! :smile: To give you a visual understanding of the project, we have recorded a short demonstration video on YouTube: +Yes, of course! :smile: To give you a visual understanding of the project, we have recorded a short demonstration GIF for `gowebly create` command: - +gowebly create ## Where else can I read something about the CLI? diff --git a/docs/getting-started.md b/docs/getting-started.md index 4f1b098..dd21655 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -9,33 +9,25 @@ This section will help you understand what **Gowebly** CLI is. -The **Gowebly** CLI is a free and open source software that helps to easily build amazing web applications with Go on the backend, using htmx & hyperscript and the most popular atomic/utility-first CSS frameworks on the frontend. +The **Gowebly** CLI is a free and open source software that helps to easily build amazing web applications with Go on the backend, using htmx & hyperscript and the most popular CSS frameworks on the frontend. -CLI generates a ready-to-use project that helps to understand the **Go** + **htmx** + **hyperscript** + **CSS framework** technology stack as quickly as possible and start working on it with maximum developer comfort. Many project elements are already optimally configured and ready for use. +CLI generates a ready-to-use project that helps to understand **Go** + **htmx** technology stack as quickly as possible and start working on it with maximum developer comfort. Many project elements are already optimally configured and ready for production. -This is shown more clearly in the diagram below: +To visualize the workflow, please refer to the diagram: ```mermaid stateDiagram-v2 direction LR Install: Install CLI - Init: Initialize config Doctor: View diagnostics Create: Create new project Run: Run project - Build: Build project - Deploy: Deploy to server [*] --> Install - Install --> Init Install --> Create Install --> Doctor Doctor --> [*] - Init --> Create Create --> Run Run --> [*] - Create --> Build - Build --> Deploy - Deploy --> [*] ``` \ No newline at end of file diff --git a/docs/getting-started/build-from-source.md b/docs/getting-started/build-from-source.md index d751158..c8d68c6 100644 --- a/docs/getting-started/build-from-source.md +++ b/docs/getting-started/build-from-source.md @@ -1,3 +1,9 @@ +--- +next: + text: 'Our team' + link: '/getting-started/our-team' +--- + # Build from the source The basics for building the **Gowebly** project in manual mode are covered in this section. @@ -15,23 +21,13 @@ git clone https://github.com/gowebly/gowebly && cd gowebly Edit everything you need in the source code and run the `go build` command from the project's root folder to build the binary: ``` bash -go build . +go build -o ./bin/my_gowebly ``` -Now you can run your own binary with **Gowebly** CLI. - -## Create Docker image - -::: danger Dockerfile -Since we are using the [GoReleaser][other_goreleaser_url] tool in our pipeline, you need to create your own `Dockerfile` file in the root of the repository to create a Docker image. -::: - -Edit everything you need in the source code and build the Docker image: +And now, you can use your own binary with **Gowebly** CLI: ``` bash -docker build -t my-gowebly-image:latest . +./bin/my_gowebly [COMMAND] ``` -Now you can use your own Docker image to run a container with **Gowebly** CLI. - \ No newline at end of file diff --git a/docs/getting-started/how-does-it-work.md b/docs/getting-started/how-does-it-work.md index d5377bd..e251892 100644 --- a/docs/getting-started/how-does-it-work.md +++ b/docs/getting-started/how-does-it-work.md @@ -13,29 +13,47 @@ The **Gowebly** CLI is built on top of the [Go][go_url] programming language. Therefore, it can run successfully on any supported system and architecture as an executable application. All the templates for the project (both backend and frontend) that it generates as a result of its work are already included in this executable. That is, you do not need any additional files to work with the CLI. -A lot of the processes that the CLI runs under the hood are executed in parallel, thanks to **goroutines**. - ## Backend part The templates for the **backend** part of your project have been thoroughly tested and contain only the features and parameters you need to get started. You can use them as a good start and improve them as your project grows. At this moment, the CLI supported the following Go web frameworks: [Fiber][backend_fiber_url], [Gin][backend_gin_url], [Echo][backend_echo_url], [Chi][backend_chi_url] and [HttpRouter][backend_httprouter_url]. By default, created project will use the built-in [net/http][backend_net_http_url] package. -To be more efficient, the CLI supports the [Templ][backend_ah_templ_url] templating engine. With its help, you can rapidly create UIs for your project without leaving the traditional Go environment. All templates are regular Go functions, without having to create additional HTML templates and deal with the built-in Go templating engine (from the `html/template` package). +### Server layer for htmx + +The CLI uses the [htmx-go][backend_angelofallars_go_htmx_url] package, which provides a more convenient API for using the [htmx][frontend_htmx_url] server layer in the backend part of your project. + +::: warning Please note +All web frameworks are supported this package, except **Fiber**. As soon as its developers provide an adapter for integration or write their own wrapper to work with. +::: + +### Templ + +To be more efficient, the CLI supports the [Templ][backend_a_h_templ_url] templating engine. With its help, you can rapidly create UIs for your project without leaving the traditional Go environment. + +All templates are regular Go functions, without having to create additional HTML templates and deal with the built-in Go templating engine (from the `html/template` package). ## Frontend part -To create a build for the **frontend** part, the quick and easy [Parcel][frontend_parcel_url] bundler version `2` was chosen. This allowed us to reduce the unnecessarily stressful moment of frontend build to the maximum. No more need to understand configurations, the CLI has already prepared it for you. +To create a build for the **frontend** part, the quick and easy [Parcel][frontend_parcel_url] bundler version `2` was chosen. This allowed us to reduce the unnecessarily stressful moment of frontend build to the maximum. + +No more need to understand configurations, the CLI has already prepared it for you. + +At this moment, the CLI supported the following CSS frameworks: [Tailwind CSS][frontend_tailwindcss_url], [UnoCSS][frontend_unocss_url], [Bootstrap][frontend_bootstrap_url], [Bulma][frontend_bulma_url], [daisyUI][frontend_daisyui_url] and [Flowbite][frontend_flowbite_url] components library. By default, created project will use the minimal CSS styles to demonstration. -At this moment, the CLI supported the following CSS frameworks: [Tailwind CSS][frontend_tailwindcss_url], [UnoCSS][frontend_unocss_url], [Bootstrap][frontend_bootstrap_url], [Bulma][frontend_bulma_url] and [daisyUI][frontend_daisyui_url] components library. By default, created project will use the minimal CSS styles to demonstration. +### Frontend runtime environment -### JavaScript runtime environment +We keep up with the latest updates to **frontend development tools**, so the CLI supports two JavaScript runtime environments: via the standard [Node.js][frontend_nodejs_url] and the new and extremely fast [Bun][frontend_bun_url] (which is backwards compatible with Node.js). -We keep up with the latest updates to **frontend development tools**, so the CLI supports two JavaScript runtime environments: via the standard [Node.js][frontend_nodejs_url] and the new and extremely fast [Bun][frontend_bun_url] (which is backwards compatible with Node.js). You can choose whichever you like best for your project in the CLI settings. +You can choose whichever you like best for your project. ### htmx & hyperscript -The CLI also includes an HTTP client that allows background downloading of [htmx][frontend_htmx_url] and [hyperscript][frontend_hyperscript_url] JavaScript files from a remote CDN for further use in your project. +The [htmx][frontend_htmx_url] and [hyperscript][frontend_hyperscript_url] reactive libraries are available as regular NPM packages in the `package.json` and will be added to the project "as is" in the `./assets/scripts.js` file. + +### Prettier + +Since `v2.0.0`, the **Gowebly** CLI supports the [Prettier][frontend_prettier_url] formatter to format your files. ## Deploy diff --git a/docs/getting-started/our-team.md b/docs/getting-started/our-team.md index 00769a1..0bc02ed 100644 --- a/docs/getting-started/our-team.md +++ b/docs/getting-started/our-team.md @@ -1,6 +1,9 @@ --- editLink: false lastUpdated: false +prev: + text: 'Build from the source' + link: '/getting-started/build-from-source' next: text: 'Complete user guide' link: '/complete-user-guide' @@ -20,14 +23,6 @@ const members = [ { icon: 'github', link: 'https://github.com/koddr' }, { icon: 'linkedin', link: 'https://www.linkedin.com/in/koddr' } ] - }, - { - avatar: 'https://www.github.com/truewebartisans.png', - name: 'True Web Artisans', - title: 'Contribution & Support', - links: [ - { icon: 'github', link: 'https://github.com/truewebartisans' } - ] } ] diff --git a/docs/parts/links.md b/docs/parts/links.md index a2a57f1..818db0d 100644 --- a/docs/parts/links.md +++ b/docs/parts/links.md @@ -3,9 +3,6 @@ [repo_issues_url]: https://github.com/gowebly/gowebly/issues [repo_releases_url]: https://github.com/gowebly/gowebly/releases [repo_discussions_url]: https://github.com/gowebly/gowebly/discussions - -[repo_default_config]: https://github.com/gowebly/gowebly/blob/main/internal/attachments/configs/default.yml - [repo_docs_url]: https://github.com/gowebly/docs [repo_docs_pr_url]: https://github.com/gowebly/docs/pulls @@ -27,7 +24,8 @@ [backend_echo_url]: https://github.com/labstack/echo [backend_chi_url]: https://github.com/go-chi/chi [backend_httprouter_url]: https://github.com/julienschmidt/httprouter -[backend_ah_templ_url]: https://github.com/a-h/templ +[backend_a_h_templ_url]: https://github.com/a-h/templ +[backend_angelofallars_go_htmx_url]: https://github.com/angelofallars/htmx-go @@ -35,16 +33,14 @@ [frontend_hyperscript_url]: https://hyperscript.org [frontend_tailwindcss_url]: https://tailwindcss.com [frontend_daisyui_url]: https://daisyui.com +[frontend_flowbite_url]: https://flowbite.com [frontend_unocss_url]: https://unocss.dev [frontend_bootstrap_url]: https://getbootstrap.com [frontend_bulma_url]: https://bulma.io [frontend_nodejs_url]: https://nodejs.org [frontend_bun_url]: https://bun.sh [frontend_parcel_url]: https://parceljs.org - - - -[docker_gowebly_image_url]: https://hub.docker.com/repository/docker/gowebly/gowebly +[frontend_prettier_url]: https://prettier.io @@ -64,5 +60,4 @@ [other_gowebly_helpers_url]: https://github.com/gowebly/helpers [other_wsl_url]: https://learn.microsoft.com/en-us/windows/wsl/ [other_goreleaser_url]: https://goreleaser.com -[other_brew_url]: https://brew.sh -[other_unpkg_url]: https://unpkg.com \ No newline at end of file +[other_brew_url]: https://brew.sh \ No newline at end of file diff --git a/docs/ru/complete-user-guide/info-about-system.md b/docs/ru/complete-user-guide/info-about-system.md new file mode 100644 index 0000000..a4f9050 --- /dev/null +++ b/docs/ru/complete-user-guide/info-about-system.md @@ -0,0 +1,36 @@ +# Info about your system + +To view information about your system, execute the `doctor` command: + +::: code-group +```bash [CLI] +gowebly doctor +``` + +```bash [Go] +go run github.com/gowebly/gowebly@latest doctor +``` +::: + +And result will be: + +``` +✓ Your system information has been collected successfully! + +│ +│ Copy this information to paste into an issue ↘ +│ +│ Gowebly CLI: v2.0.1 (build with go1.21.5 on darwin/arm64) +│ +│ Go: 1.21.5 darwin/arm64 +│ Node.js version: 21.5.0 (npm 10.2.4) +│ Bun version: 1.0.21 +│ +│ Is Air tool installed? true +│ Is Templ package installed? true +│ + +✱ For more information go to the official docs: https://gowebly.org +``` + + \ No newline at end of file diff --git a/docs/ru/getting-started.md b/docs/ru/getting-started.md index 966dcff..b8cce07 100644 --- a/docs/ru/getting-started.md +++ b/docs/ru/getting-started.md @@ -19,23 +19,15 @@ CLI генерирует готовый к использованию проек stateDiagram-v2 direction LR Install: Установка CLI - Init: Инициализация конфига Doctor: Просмотр диагностики Create: Создание нового проекта Run: Запуск проекта - Build: Сборка проекта - Deploy: Развертывание на сервере [*] --> Install - Install --> Init Install --> Create Install --> Doctor Doctor --> [*] - Init --> Create Create --> Run Run --> [*] - Create --> Build - Build --> Deploy - Deploy --> [*] ``` \ No newline at end of file diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index ecd818d..86ce680 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -10,19 +10,6 @@ The most common malfunctions that may come up when using the **Gowebly** CLI. -## Docker: The requested image's platform does not match the detected host platform - -The official **Gowebly** [Docker image][docker_gowebly_image_url] is available for GNU/Linux only: - -- `linux/amd64` -- `linux/arm64` - -Other architectures and operating systems are **not** supported. - -::: tip Windows Subsystem for Linux -Yes, **Gowebly** CLI perfectly works on the [Windows Subsystem for Linux][other_wsl_url] (WSL) too, because it uses Ubuntu as the GNU/Linux distro. -::: - ## Port X is taken by OS Some operating systems may take up ports that you want to use to develop and deploy your application. You can check if a port is taken by OS by running the command: @@ -41,13 +28,45 @@ netstat -aon ``` ::: -To change the port number, replace `port` option in the `.gowebly.yml` file with the port number you want to use for the backend: +There are two ways to change it. + +1. Set the port number in the `BACKEND_PORT` environment variable before running: + +::: code-group +``` bash [CLI] +BACKEND_PORT=9000 gowebly run +``` + +``` yaml{7,9} [Docker] +# docker-compose.yml + +services: + gowebly_default: + # ... + ports: + - '9000:9000' + environment: + BACKEND_PORT: 9000 # same as the exposed container port + # ... + +# ... +``` +::: + +2. Edit the port number in the `server.go` file: + +``` go{4} +// runServer runs a new HTTP server with the loaded environment variables. +func runServer() error { + // Validate environment variables. + port, err := strconv.Atoi(gowebly.Getenv("BACKEND_PORT", "9000")) + if err != nil { + return err + } -``` yaml{2} -backend: - port: 9000 + // ... ``` -Re-run your application and go to the `http://localhost:9000`. +Now, you can open your browser and go to the `http://localhost:9000`. \ No newline at end of file diff --git a/docs/zh_HK/complete-user-guide/info-about-system.md b/docs/zh_HK/complete-user-guide/info-about-system.md new file mode 100644 index 0000000..a4f9050 --- /dev/null +++ b/docs/zh_HK/complete-user-guide/info-about-system.md @@ -0,0 +1,36 @@ +# Info about your system + +To view information about your system, execute the `doctor` command: + +::: code-group +```bash [CLI] +gowebly doctor +``` + +```bash [Go] +go run github.com/gowebly/gowebly@latest doctor +``` +::: + +And result will be: + +``` +✓ Your system information has been collected successfully! + +│ +│ Copy this information to paste into an issue ↘ +│ +│ Gowebly CLI: v2.0.1 (build with go1.21.5 on darwin/arm64) +│ +│ Go: 1.21.5 darwin/arm64 +│ Node.js version: 21.5.0 (npm 10.2.4) +│ Bun version: 1.0.21 +│ +│ Is Air tool installed? true +│ Is Templ package installed? true +│ + +✱ For more information go to the official docs: https://gowebly.org +``` + + \ No newline at end of file diff --git a/docs/zh_HK/getting-started.md b/docs/zh_HK/getting-started.md index d09f026..539e48d 100644 --- a/docs/zh_HK/getting-started.md +++ b/docs/zh_HK/getting-started.md @@ -19,23 +19,15 @@ CLI 可生成一个即用型项目，帮助开发人员尽快了解 Go + htmx + stateDiagram-v2 direction LR Install: 安装 CLI - Init: 初始化配置 Doctor: 查看诊断 Create: 创建新项目 Run: 运行项目 - Build: 建设项目 - Deploy: 部署到服务器 [*] --> Install - Install --> Init Install --> Create Install --> Doctor Doctor --> [*] - Init --> Create Create --> Run Run --> [*] - Create --> Build - Build --> Deploy - Deploy --> [*] ``` \ No newline at end of file