forked from beego/beedoc
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial commit for Russian translate in BeeGo docs
- Loading branch information
1 parent
97ddce1
commit b9cfa6d
Showing
21 changed files
with
1,057 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# О BeeGo | ||
|
||
[![Build Status](https://drone.io/github.com/astaxie/beego/status.png)](https://drone.io/github.com/astaxie/beego/latest) [![Go Walker](http://gowalker.org/api/v1/badge)](http://gowalker.org/github.com/astaxie/beego) | ||
|
||
Это руководство документирует BeeGo App Framework | ||
|
||
### Новичок в BeeGo? | ||
|
||
Читай о [Быстром старте](quickstart). | ||
|
||
### Не можешь что-то найти? | ||
|
||
Поищи в [списке рассылки ([email protected])](https://groups.google.com/forum/#!forum/beego-framework). | ||
|
||
### Нужна помощь? | ||
|
||
Напиши email на [[email protected]](mailto:[email protected]). | ||
|
||
### Нашел баг? | ||
|
||
Открой [тикет на github](https://github.com/astaxie/beego/issues). | ||
|
||
### Хочешь помочь проекту? | ||
|
||
Форкни [документацию](https://github.com/beego/beedoc), улучши и сделай пулл-реквест. | ||
|
||
### Ищешь исходный код сайта? | ||
|
||
Посети [Beego Web](https://github.com/beego/beeweb). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
root: true | ||
name: Middleware contribution | ||
sort: 7 | ||
--- | ||
|
||
С развитием beego, библиотек с его использованием становится всё больше и больше, так что если у вас есть | ||
библиотека сделанная на основе beego, то мы будем рады получить ссылку на неё | ||
|
||
- [gorelic](https://github.com/yvasiyarov/beego_gorelic) | ||
- [pongo2](https://github.com/oal/beego-pongo2) | ||
- [keenio](https://github.com/pabdavis/beego_keenio) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Помоги Beego | ||
|
||
<h4> | ||
<b><font color="red"> | ||
<p>Beego фреймворк специально создан для быстрой разработки веб-приложений и защиты чести языка Go. | ||
Ваша поддержка очень ценится и многое значит для нас.</p> | ||
<p>Core-команда Beego работает над развитием Beego уже больше года. Мы много вложили что бы предоставить лучший фреймворк каждому. И если вы чувствуете что Beego полезен для вас и вы хотите дружески поддержать наш проект, то мы будем благодарны ^_^</p> | ||
</font></b> | ||
</h4> | ||
|
||
<h4> | ||
<b>Пожертвовать через Paypal:</b> | ||
<p> | ||
<form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top"> | ||
<input type="hidden" name="cmd" value="_s-xclick"> | ||
<input type="hidden" name="hosted_button_id" value="MR3MV8ZX9BWJ2"> | ||
<table> | ||
<tr><td><input type="hidden" name="on0" value="support beego">помочь beego</td></tr><tr><td><select name="os0"> | ||
<option value="Option 1">Вариант 1 $10.00 USD</option> | ||
<option value="Option 2">Вариант 2 $20.00 USD</option> | ||
<option value="Option 3">Вариант 3 $50.00 USD</option> | ||
<option value="Option 4">Вариант 4 $100.00 USD</option> | ||
<option value="Option 5">Вариант 5 $200.00 USD</option> | ||
<option value="Option 6">Вариант 6 $500.00 USD</option> | ||
<option value="Option 7">Вариант 7 $1,000.00 USD</option> | ||
</select> </td></tr> | ||
</table> | ||
<input type="hidden" name="currency_code" value="USD"> | ||
<input type="image" src="https://www.paypalobjects.com/en_US/C2/i/btn/btn_buynowCC_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> | ||
<img alt="" border="0" src="https://www.paypalobjects.com/en_US/i/scr/pixel.gif" width="1" height="1"> | ||
</form> | ||
</p> | ||
</h4> | ||
|
||
### Ваше пожертвование будет использовано для: | ||
|
||
- Поддержки разработки Beego | ||
- Поддержки развития коммьюнити | ||
- Поддержки проведения лекций | ||
- Улучшения серверов | ||
- Награждения внешних участников проекта | ||
|
||
### Список пожертвовавших (последние сверху) | ||
|
||
| Donated at | Donator | Amount | Comments | | ||
| ---------------- |:---------:| --------:| ----------------------- | | ||
| 2014-Jan-24 | Bernard Lim | $20.00 | | | ||
| 2013-Dec-23 | William Kennedy | $100.00 | | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
root: true | ||
name: FAQ | ||
sort: 99 | ||
--- | ||
|
||
# FAQ | ||
|
||
1. Приложение не может найти файлы шаблонов или конфигурации или же случается ошибка "nil pointer". | ||
|
||
Это может быть связано с использованием `go run main.go` для запуска приложения. `go run` компилирует файл и складывает бинарник во временную папку. Но Beego нуждается в файлах статики, шаблонах и конфигурационных файлах которые лежат не во временной папке, а в папке вашего приложения. Так что вам нужно использовать `go build` и запускать обязательно из папки вашего приложения, для примера: `./app`. Или вы можете испольвать `bee run app`. | ||
|
||
2. Может ли Beego использовать для реальных проектов? | ||
|
||
Да. Beego уже используется для реальных проектов. E.g.: SNDA CND system, 360 search API, Bmob mobile cloud API, weico backend API etc. Все они являются высоконагруженными реальными проектами. | ||
|
||
3. Может ли API которое я использую сейчас быть сломанным в будущем? | ||
|
||
Beego остается со стабильным API с версии 0.1. Большинство приложений обновляются до последней версии Beego достаточно просто. И мы будем пытаться сохранить API стабильным и в будущем. | ||
|
||
4. Будет ли Beego продолжать развиваться? | ||
|
||
Множество людей волнуется о том что open source проекты могут быть заброшены. Но мы имеем четырех людей которые постоянно пишут код. Мы будем продолжать делать Beego лучше и лучше. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,221 @@ | ||
--- | ||
name: Bee tool usage | ||
sort: 2 | ||
--- | ||
|
||
# Введение в инструменты разработки bee tool | ||
|
||
Bee tool это проект который помогает быстрее разрабатывать с beego. С bee tool мы можем создавать, автоматически компилировать и перезагружать, тестировать и деплоить приложение проще. | ||
|
||
## Устанавливаем bee tool | ||
|
||
Вы можете установить bee tool используя следующую команду: | ||
|
||
go get github.com/beego/bee | ||
|
||
`bee` будет установлен в `GOPATH/bin` по-умолчанию. Вам надо добавить `GOPATH/bin` в вашу переменную окружения PATH, в противном случае команда `bee` не будет работать. | ||
|
||
## Bee tool команды | ||
|
||
Наберите `bee` в консоли. Вы должны увидеть следующее: | ||
|
||
``` | ||
Bee is a tool for managing beego framework. | ||
Usage: | ||
bee command [arguments] | ||
The commands are: | ||
new create an application base on beego framework | ||
run run the app which can hot compile | ||
pack compress an beego project | ||
api create an api application base on beego framework | ||
router auto-generate routers for the app controllers | ||
test test the app | ||
bale packs non-Go files to Go source files | ||
``` | ||
|
||
### Команда new | ||
|
||
`new` создает новый веб-проект. Вы можете создать новый beego проект набрав `bee new <project name>` находясь в `$GOPATH/src`. Это сгенерирует все проектные папки и файлы: | ||
|
||
``` | ||
bee new myproject | ||
[INFO] Creating application... | ||
/gopath/src/myproject/ | ||
/gopath/src/myproject/conf/ | ||
/gopath/src/myproject/controllers/ | ||
/gopath/src/myproject/models/ | ||
/gopath/src/myproject/static/ | ||
/gopath/src/myproject/static/js/ | ||
/gopath/src/myproject/static/css/ | ||
/gopath/src/myproject/static/img/ | ||
/gopath/src/myproject/views/ | ||
/gopath/src/myproject/conf/app.conf | ||
/gopath/src/myproject/controllers/default.go | ||
/gopath/src/myproject/views/index.tpl | ||
/gopath/src/myproject/main.go | ||
13-11-25 09:50:39 [SUCC] New application successfully created! | ||
``` | ||
|
||
``` | ||
myproject | ||
├── conf | ||
│ └── app.conf | ||
├── controllers | ||
│ └── default.go | ||
├── main.go | ||
├── models | ||
├── static | ||
│ ├── css | ||
│ ├── img | ||
│ └── js | ||
└── views | ||
└── index.tpl | ||
8 directories, 4 files | ||
``` | ||
|
||
### Команда run | ||
|
||
When we develop a Go project, we often have problem that we need to compile the project and run it manually. `bee run` command will supervise the file system of beego project using inotify so that we can see the result directly after the modifications for project. | ||
|
||
Когда мы разрабатываем проект на Go, мы всегда имеем проблему с потребностью постоянно компилировать и перезапускать бинарник приложения вручную. `bee run` будет следить за файловой системой в вашем beego проекте используя inotify. Таким образом мы можем видеть результат сразу же после внесения изменений в проекте. | ||
|
||
``` | ||
bee run | ||
13-11-25 09:53:04 [INFO] Uses 'myproject' as 'appname' | ||
13-11-25 09:53:04 [INFO] Initializing watcher... | ||
13-11-25 09:53:04 [TRAC] Directory(/gopath/src/myproject/controllers) | ||
13-11-25 09:53:04 [TRAC] Directory(/gopath/src/myproject/models) | ||
13-11-25 09:53:04 [TRAC] Directory(/gopath/src/myproject) | ||
13-11-25 09:53:04 [INFO] Start building... | ||
13-11-25 09:53:16 [SUCC] Build was successful | ||
13-11-25 09:53:16 [INFO] Restarting myproject ... | ||
13-11-25 09:53:16 [INFO] ./myproject is running... | ||
``` | ||
Откройте браузер и перейдите на `http://localhost:8080/`, и вы должны увидеть изменения: | ||
|
||
![](../images/beerun.png) | ||
|
||
После изменения `default.go` в папке `controllers`, мы можем видеть | ||
подобный вывод в консоли: | ||
|
||
``` | ||
13-11-25 10:11:20 [EVEN] "/gopath/src/myproject/controllers/default.go": DELETE|MODIFY | ||
13-11-25 10:11:20 [INFO] Start building... | ||
13-11-25 10:11:20 [SKIP] "/gopath/src/myproject/controllers/default.go": CREATE | ||
13-11-25 10:11:23 [SKIP] "/gopath/src/myproject/controllers/default.go": MODIFY | ||
13-11-25 10:11:23 [SUCC] Build was successful | ||
13-11-25 10:11:23 [INFO] Restarting myproject ... | ||
13-11-25 10:11:23 [INFO] ./myproject is running... | ||
``` | ||
|
||
Теперь обновите браузер и вы сможете увидеть что результат ваших модификаций уже здесь. | ||
|
||
### Команда api | ||
|
||
Команда `new` используется для создания нового веб-проекта. Но есть много разработчиков | ||
которые используют beego для создания API приложений. Вы можете использовать команду `api` для создания API приложения. Вот результат запуска `bee api project_name`: | ||
|
||
``` | ||
bee api apiproject | ||
create app folder: /gopath/src/apiproject | ||
create conf: /gopath/src/apiproject/conf | ||
create controllers: /gopath/src/apiproject/controllers | ||
create models: /gopath/src/apiproject/models | ||
create tests: /gopath/src/apiproject/tests | ||
create conf app.conf: /gopath/src/apiproject/conf/app.conf | ||
create controllers default.go: /gopath/src/apiproject/controllers/default.go | ||
create tests default.go: /gopath/src/apiproject/tests/default_test.go | ||
create models object.go: /gopath/src/apiproject/models/object.go | ||
create main.go: /gopath/src/apiproject/main.go | ||
``` | ||
|
||
Получившаяся структура API приложения: | ||
|
||
``` | ||
apiproject | ||
├── conf | ||
│ └── app.conf | ||
├── controllers | ||
│ └── default.go | ||
├── main.go | ||
├── models | ||
│ └── object.go | ||
└── tests | ||
└── default_test.go | ||
``` | ||
|
||
В сравнении с веб-приложением, приложение для API не содержит файлы статики и шаблоны, но | ||
имеет модуль для запуска unit тестирования. | ||
|
||
### Команда test | ||
|
||
Это обёртка над `go test`. Она запускает тест-кейсы из папки tests в вашем beego проекте. | ||
|
||
``` | ||
bee test apiproject | ||
13-11-25 10:46:57 [INFO] Initializing watcher... | ||
13-11-25 10:46:57 [TRAC] Directory(/gopath/src/apiproject/controllers) | ||
13-11-25 10:46:57 [TRAC] Directory(/gopath/src/apiproject/models) | ||
13-11-25 10:46:57 [TRAC] Directory(/gopath/src/apiproject) | ||
13-11-25 10:46:57 [INFO] Start building... | ||
13-11-25 10:46:58 [SUCC] Build was successful | ||
13-11-25 10:46:58 [INFO] Restarting apiproject ... | ||
13-11-25 10:46:58 [INFO] ./apiproject is running... | ||
13-11-25 10:46:58 [INFO] Start testing... | ||
13-11-25 10:46:59 [TRAC] ============== Test Begin =================== | ||
PASS | ||
ok apiproject/tests 0.100s | ||
13-11-25 10:47:00 [TRAC] ============== Test End =================== | ||
13-11-25 10:47:00 [SUCC] Test finish | ||
``` | ||
|
||
### Команда pack | ||
|
||
Команда `pack` используется для запаковки вашего проекта в один файл. Вы можете использовать это при деплое вашего приложения, для загрузки и извлечения содержимого архива на сервере. | ||
|
||
``` | ||
bee pack | ||
app path: /gopath/src/apiproject | ||
GOOS darwin GOARCH amd64 | ||
build apiproject | ||
build success | ||
exclude prefix: | ||
exclude suffix: .go:.DS_Store:.tmp | ||
file write to `/gopath/src/apiproject/apiproject.tar.gz` | ||
``` | ||
|
||
Вы можете увидеть архив в корне вашего проекта: | ||
|
||
``` | ||
rwxr-xr-x 1 astaxie staff 8995376 11 25 22:46 apiproject | ||
-rw-r--r-- 1 astaxie staff 2240288 11 25 22:58 apiproject.tar.gz | ||
drwxr-xr-x 3 astaxie staff 102 11 25 22:31 conf | ||
drwxr-xr-x 3 astaxie staff 102 11 25 22:31 controllers | ||
-rw-r--r-- 1 astaxie staff 509 11 25 22:31 main.go | ||
drwxr-xr-x 3 astaxie staff 102 11 25 22:31 models | ||
drwxr-xr-x 3 astaxie staff 102 11 25 22:31 tests | ||
``` | ||
|
||
### Команда router | ||
|
||
На данный момент эта команда еще не работает. В будущем она будет генерировать роуты на основе анализа методов в контроллерах. | ||
|
||
### Команда bale | ||
|
||
Эта команда доступна только девелоперам на данный момент. Её основное назначение это сжатие всей статики в один бинарный файл. Таким образом вам не нужно волноваться о доставке js, css файлов, изображений и шаблонов когда вы деплоите проект. Эти файлы будут автоматически извлечены с невозможностью перезаписи когда вы запустите вашу программу. | ||
|
||
## Bee tool конфигурация | ||
|
||
Вы можете заметить, что в исходных кодах bee tool есть файл с именем `bee.json`. Это файл конфигурации beego. Полный список его возможностей всё еще не существует, но вот некоторые опции которые вы можете использовать уже сейчас: | ||
|
||
- `"version": 0`: version of file, for checking incompatible format version. | ||
- `"go_install": false`: if you use full import path like `github.com/user/repo/subpkg`, then you can enable this opetion to run `go install` and speed up you build processes. | ||
- `"watch_ext": []`: add other file extensions to watch(only watch `.go` files by default). For example, `.ini`, `.conf`, etc. | ||
- `"dir_structure":{}`: if your folders' name are not same as MVC classic name, you can use this option use change them. | ||
- `"cmd_args": []`: add command arguments for every start. | ||
- `"envs": []`: setting environment variables for every start. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
root: true | ||
name: Install / Upgrade | ||
sort: 1 | ||
--- | ||
|
||
# Установка beego | ||
|
||
Вы можете использовать классический путь для установки beego: | ||
|
||
go get github.com/astaxie/beego | ||
|
||
Часто задаваемые вопросы: | ||
|
||
- git is not installed. Please install git for your system. | ||
- git https is not accessible. Please config local git and close https validation: | ||
|
||
git config --global http.sslVerify false | ||
|
||
- How can I install beego offline? There is no good solution now. We will creat packages for downloading and installing for every release. | ||
|
||
# Обновление beego | ||
|
||
Вы можете обновить beego используя команду Go или скачав и заменив исходный код. | ||
|
||
- Используя Go команду: мы рекомендуем использовать этот вариант для обновления beego: | ||
|
||
go get -u github.com/astaxie/beego | ||
|
||
- Используя исходный код: зайдите на `https://github.com/astaxie/beego` и скачайте исходный код. Скопируйте новый исходный код и перезапишите файлы в `$GOPATH/src/github.com/astaxie/beego`. После этого запустите `go install` для обновления beego: | ||
|
||
go install github.com/astaxie/beego | ||
|
||
# Git-ветки в beego | ||
|
||
Ветка `master` относится к стабильному коду, а вся разработка ведется в ветке `develop`. | ||
Вот наглядное изображение того как мы работаем с ветками: | ||
|
||
![](../images/git-branch-1.png) | ||
|
||
|
||
# Как я могу присоединиться к beego | ||
|
||
Исходный код Beego находится на GitHub. Вы можете форкнуть, доработать Beego и потом сделать пулл-реквест нам. Мы изучим ваш код и дадим фидбэк относительно ваших изменений так быстро как это возможно. |
Oops, something went wrong.