Categorygithub.com/codingersid/legit

modulepackage

1.2.0

Repository: https://github.com/codingersid/legit.git

Documentation: pkg.go.dev

# README

LEGIT

Legit adalah Go Framework yang dikembangkan oleh CODINGERS.ID sebagai framework yang ditujukan khusus untuk pemula belajar bahasa pemrograman Go. Framework ini kami tujukan untuk komunitas IT kami, tetapi siapapun boleh menggunakan sebagai bahan belajar dan juga bisa digunakan untuk pengembangan website dan aplikasi di production.

Framework ini jauh dari kata sempurna, jadi kami akan selalu dan terus berinovasi agar bisa menjadi framework yang berguna dan bermanfaat di dunia pemrograman.

Dikembangkan Dengan

Framework ini dibangun dengan:

Prasarat

Untuk bisa menggunakan framework ini, ada beberapa hal yang harus Anda install terlebih dahulu.

GIT
Bahasa Go versi >= 1.17
Salah Satu Database Ini:
- MySQL
- MariaDB
- PostgreSQL
Salah Satu Text Editor Ini:
Pendukung lainnya seperti Tools Manajemen Database, Browser dll

Installasi

Berikut ini langkah-langkah installasi legit framework:

Buka terminal/cmd/git bash.

git clone https://github.com/codingersid/legit.git namaAplikasiAnda

Buka folder namaAplikasiAnda di Text Editor Anda
Copy file .env.example kemudian ubah menjadi .env
Buka terminal dan jalankan server.
```
go run legit.go dev
```
Setelah berhasil, akses URL http://127.0.0.1:3000/ di Browser Anda
Selamat Legit Framework Berhasil Diinstall dan Dijalankan!

Legit CLI

Berikut ini adalah beberapa perintah yang bisa Anda jalankan di terminal dalam pengembangan projek dengan Legit:

Command Umum

Perintah untuk help.
```
go run legit.go -h
```
Perintah untuk menjalankan server.
```
go run legit.go dev
```
Perintah untuk cek versi.
```
go run legit.go versi
```

Command Controller

Controller Untuk REST API

Perintah untuk membuat controller.
```
go run legit.go controller:api [controllernya]
```
Contoh: go run legit.go controller:api auth/login
Perintah untuk membuat controller + route.
```
go run legit.go controller:api [controllernya] --with:route
```
Contoh: go run legit.go controller:api auth/login --with:route

Controller Untuk Web

Perintah untuk membuat controller.
```
go run legit.go controller:web [controllernya]
```
Contoh: go run legit.go controller:web front_end/home
Perintah untuk membuat controller + route.
```
go run legit.go controller:web [controllernya] --with:route
```
Contoh: go run legit.go controller:web front_end/home --with:route

Command Route

Route Untuk REST API

Perintah untuk membuat route.
```
go run legit.go route:api [controllernya]
```
Contoh: go run legit.go route:api auth/login. Command ini mirip seperti go run legit.go controller:web front_end/home --with:route, namun dijalankan terpisah apabila membutuhkan route untuk controller yang telah dibuat sebelumnya tanpa flags --with:route.

Route Untuk Web

Perintah untuk membuat route.
```
go run legit.go route:web [controllernya]
```
Contoh: go run legit.go route:web front_end/home. Command ini mirip seperti go run legit.go controller:web front_end/home --with:route, namun dijalankan terpisah apabila membutuhkan route untuk controller yang telah dibuat sebelumnya tanpa flags --with:route.

Command View

Membuat Layout

Perintah untuk membuat layout.
```
go run legit.go layout [layoutnya]
```
Contoh: go run legit.go layout layout. Anda bisa membuat lebih dari 1 layout apabila dibutuhkan, dan bisa diletakkan di path tertentu, misalnya di path auth go run legit.go layout auth/layout.

Membuat Partial

Perintah untuk membuat partial scripts.
```
go run legit.go partial:script [scriptnya]
```
Contoh: go run legit.go partial:script home. Anda bisa membuat lebih dari 1 file partial script apabila dibutuhkan, dan bisa diletakkan di path tertentu, misalnya di path auth go run legit.go partial:script auth/login.
Perintah untuk membuat partial header.
```
go run legit.go partial:header [headernya]
```
Contoh: go run legit.go partial:header home. Anda bisa membuat lebih dari 1 file partial header apabila dibutuhkan, dan bisa diletakkan di path tertentu, misalnya di path auth go run legit.go partial:header auth/login.
Perintah untuk membuat partial sidebar.
```
go run legit.go partial:sidebar [sidebarnya]
```
Contoh: go run legit.go partial:sidebar home. Anda bisa membuat lebih dari 1 file partial sidebar apabila dibutuhkan, dan bisa diletakkan di path tertentu, misalnya di path auth go run legit.go partial:sidebar auth/login.

Membuat Page

Perintah untuk membuat page.
```
go run legit.go page [pagenya]
```
Contoh: go run legit.go page home. Anda bisa membuat lebih dari 1 page apabila dibutuhkan, dan bisa diletakkan di path tertentu, misalnya di path auth go run legit.go page auth/login.

Command Generate

Generate Route

Perintah untuk generate route api.
```
go run legit.go generate:route-api
```
Command ini akan mendeteksi semua controller api yang berada di path app/http/controllers/api kemudian men-generate seluruh routenya ke path routes/inners_api. Hanya controller yang tidak memiliki route yang akan di-generate.
Perintah untuk generate route web.
```
go run legit.go generate:route-web
```
Command ini akan mendeteksi semua controller web yang berada di path app/http/controllers/web kemudian men-generate seluruh routenya ke path routes/inners_api. Hanya controller yang tidak memiliki route yang akan di-generate.

Command Model dan lainnya

Perintah untuk membuat migration.
```
go run legit.go migration [migrationnya]
```
Contoh: go run legit.go migration users. Command ini untuk membuat schema table yang akan di migrasi ke database Anda. Buatlah nama migration sesuai nama tabel yang akan Anda buat. Penggunaan path tidak diizinkan pada command ini.
Perintah untuk membuat model.
```
go run legit.go model [modelnya]
```
Contoh: go run legit.go model users. Command ini untuk membuat model yang akan menghubungkan controller dengan table yang ada di database dengan ORM. Buatlah nama model sesuai nama tabel yang akan dihubungkan. Penggunaan path tidak diizinkan pada command ini.
Perintah untuk membuat seeder.
```
go run legit.go seeder [seedernya]
```
Contoh: go run legit.go seeder users. Command ini untuk membuat seeder yang bisa menjalankan kode demo dan lain-lain. Penggunaan path tidak diizinkan pada command ini.
Perintah untuk membuat request.
```
go run legit.go request [requestnya]
```
Contoh: go run legit.go request users. Command ini untuk membuat request dengan aturan-aturan khusus yang diperlukan sebagai langkah perlindungan dan pengaturan request pada form. Penggunaan path tidak diizinkan pada command ini.
Perintah untuk membuat middleware.
```
go run legit.go middleware [middlewarenya]
```
Contoh: go run legit.go middleware admin. Command ini untuk membuat middleware dengan aturan-aturan khusus yang diperlukan sebagai langkah perlindungan terhadap route. Penggunaan path tidak diizinkan pada command ini.

Menjalankan Command legit di Terminal

Apabila Anda merasa command dengan go run legit.go [command] terlalu panjang, Anda bisa mengatur di terminal agar bisa menjadi singkat menjadi legit [command]

Pengaturan di Mac/Unix/Linux

Buka project Anda dengan Text Editor, lalu jalankan terminal.

Jalankan perintah berikut ini:

go install

export PATH=$PATH:$(go env GOPATH)/bin

source ~/.zshrc

atau

source ~/.bashrc

atau

source ~/.profile

Pengaturan di Windows

Buka project Anda dengan Text Editor, lalu jalankan terminal.
Jalankan perintah berikut ini:
```
go install
```
Tambahkan C:\Go\bin pada PATH Windows Anda.Menginstall Path Go di Windows

Template Engine

Untuk mempermudah pembuatan project, khususnya website, maka diperlukan template enginge. Legit menggunakan template engine dari HTML yang disediakan oleh Fiber.

Kontribusi

Apabila Ingin berkontribusi dalam pengembangan framework ini, silahkan Anda Fork repositori ini.

Kontak

Kontak kami ada di link pada akhir file ini, bisa hubungi kami melalui Instagram.

Support dan Sponsorship

Apabila Anda ingin mensupport kami dalam bentuk finansial ataupun lainnya, kami terbuka untuk hal tersebut.

Dokumentasi

Kami belum memiliki website dokumentasi, namun Anda bisa melihat playlist video tutorial di channel kami.