TungNT (Blue)

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

====== Install ======

https://www.goravel.dev/getting-started/installation.html

<code bash>
git clone https://github.com/goravel/goravel.git && rm -rf goravel/.git*

mv goravel goravel.example.com

cp .env.example .env

# Tải tất cả các dependencies được khai báo trong go.mod.
# Xóa các dependencies không cần thiết.
# Cập nhật file go.sum.
go mod tidy

go run . artisan key:generate

# You need to generate JWT Token if you use Authentication.
go run . artisan jwt:secret
</code>

$GOPATH, mặc định là ~/go/bin

<code>
export GOROOT=/usr/local/go
export GOPATH=$HOME/go
export PATH=$PATH:$GOROOT/bin:$GOPATH/bin
</code>

===== Thêm Module =====

File go.mod:

<file go.mod>
module your_project_name

go 1.21

require (
    github.com/goravel/framework v1.0.0
)
</file>

Ví dụ: nếu github.com/goravel/framework chưa được khai báo, thêm nó vào require hoặc sử dụng lệnh sau để thêm module:

<code>
go get github.com/goravel/framework
</code>

===== Xóa và tải lại module =====

**Xóa cache của Go:**

<code>
go clean -modcache
</code>

**Tải lại tất cả dependencies:**

===== Tải Air qua Go =====

<code>
go install github.com/cosmtrek/air@latest
</code>

===== Start HTTP Service =====

==== air ====

https://github.com/air-verse/air

<code>
go run .

~/go/bin/air -c .air.toml
</code>

====== Build web server ======

===== supervisor =====

<code>
[program:goravel]
process_name=%(program_name)s_%(process_num)02d
;command=/usr/local/go/bin/go run /private/var/www/examples/goravel.example.com/main.go
command=/Users/tungnt/go/bin/air -c /private/var/www/examples/goravel.example.com/.air.toml
directory=/private/var/www/examples/goravel.example.com
autostart=true
autorestart=true
user=tungnt
redirect_stderr=true
stdout_logfile=/private/var/www/examples/goravel.example.com/storage/logs/horizon.log
stopwaitsecs=3600
</code>

===== nginx config =====

<code>
server {
    listen 80;
    server_name goravel.example.com;

location / {
        proxy_pass http://localhost:3000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

server {
        listen       443 ssl;

server_name goravel.example.com;

ssl_certificate     /opt/homebrew/etc/nginx/ssl/goravel.example.com.pem;
        ssl_certificate_key /opt/homebrew/etc/nginx/ssl/goravel.example.com-key.pem;

ssl_session_timeout 5m;
        ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
        ssl_ciphers  HIGH:!aNULL:!MD5;
        ssl_prefer_server_ciphers on;

location / {
        proxy_pass http://localhost:3000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }

}
</code>

====== The Basic ======

===== Controllers =====

<code>
go run . artisan make:controller test/ExampleController

go run . artisan make:controller --resource PhotoController
</code>

===== Middleware =====

<code go>
go run . artisan make:middleware ApiAuth
</code>

<file go app/http/kernel.go>
package http

import (
	"github.com/goravel/framework/contracts/http"

"goravel/app/http/middleware"
)

type Kernel struct {
}

// The application's global HTTP middleware stack.
// These middleware are run during every request to your application.
func (kernel Kernel) Middleware() []http.Middleware {
	return []http.Middleware{
		middleware.ApiAuth(),
	}
}
</file>

<file go routes/api.go>
import "github.com/goravel/framework/http/middleware"

facades.Route().Middleware(middleware.Auth()).Get("users", userController.Show)
</file>

Please fill all the letters into the box to prove you're human. V U U I R Please keep this field empty:

Edit summary