Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
/static
/tmp
*.exe
*.exe~
*~
website
.DS_Store
bee
Expand All @@ -13,4 +15,3 @@ beeweb
/log
bale/
bale.go
*.go~
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,40 @@

An open source project for official documentation website of beego app framework.

## Install site locally

Beego Web is a `go get` able project:
:warning: ARCHIVED REPO :warning:

$ go get github.com/beego/beeweb
Please note that this repo is-being or have-been replaced by [beego/beego-doc](https://github.com/beego/beego-doc) - Please DO NOT open any new Issue / PR on this repo.

Switch to project root path:
## Install site locally

$ cd $GOPATH/src/github.com/beego/beeweb
Once cloned/downloaded, you can do some of the following within the project folder:

Build and run with Go tools:
- Build and run with Go tools:

$ go build
$ ./beeweb
```sh
go get
go build
./beeweb
```

Or build with bee tool:
- Or build with bee tool:

$ bee run
```sh
bee run
```

Open your browser and visit [http://localhost:8090](http://localhost:8090).
Then you can open your browser and visit [http://localhost:8080](http://localhost:8080).

## Build as your site

This project can be easily transferred as your own documentation site, there are some tips that you may want to know:

- In the file `conf/app.ini`:

- `lang -> types`: languages that you want to support
- `lang -> names`: user-friendly name of languages.
- It's **NOT** necessary but if you want to you can use GitHub app keys as following format:

[github]
client_id=1862bcb2******f36c
client_secret=308d71ab53ccd858416cfceaed52******53c5f
Expand Down
32 changes: 32 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
module github.com/beego/beeweb

go 1.17

require (
github.com/astaxie/beego v1.12.3
github.com/beego/compress v0.0.0-20131031122501-fbacc486da67
github.com/beego/i18n v0.0.0-20161101132742-e9308947f407
github.com/howeyc/fsnotify v0.9.0
github.com/slene/blackfriday v0.0.0-20140117134005-fd3fc8f180b2
)

require (
github.com/Unknwon/goconfig v1.0.0 // indirect
github.com/beorn7/perks v1.0.1 // indirect
github.com/cespare/xxhash/v2 v2.1.1 // indirect
github.com/golang/protobuf v1.4.2 // indirect
github.com/hashicorp/golang-lru v0.5.4 // indirect
github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
github.com/prometheus/client_golang v1.7.0 // indirect
github.com/prometheus/client_model v0.2.0 // indirect
github.com/prometheus/common v0.10.0 // indirect
github.com/prometheus/procfs v0.1.3 // indirect
github.com/shiena/ansicolor v0.0.0-20151119151921-a422bbe96644 // indirect
github.com/smartystreets/goconvey v1.7.2 // indirect
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550 // indirect
golang.org/x/net v0.0.0-20190620200207-3b0461eec859 // indirect
golang.org/x/sys v0.0.0-20200615200032-f1bc736245b1 // indirect
golang.org/x/text v0.3.0 // indirect
google.golang.org/protobuf v1.23.0 // indirect
gopkg.in/yaml.v2 v2.2.8 // indirect
)
Loading