Check its license. It has its own license: read it before using it for work.

Is gFly still maintained?

Yes, active. Last change 2 months ago. Latest release v1.18.2, 2 months ago.

New, little track record. 50 stars, 2 years old, by an organization. Look at the code and the owner before running it.

gitmanual

Reading the repo

Opening the box…

How to set up gFly (JiveGroup/gFly) · gitmanual

Assembly instructions

JiveGroup/gFly

Laravel inspired web framework written in Go

Before you start

Is it free?: Check its licenseIt has its own license: read it before using it for work.
Still maintained?: Yes, activeLast change 2 months ago. Latest release v1.18.2, 2 months ago.
Can I trust it?: New, little track record50 stars, 2 years old, by an organization. Look at the code and the owner before running it.

Difficulty: Moderate
Time: about 15 min
Stars: ★ 50
Activity: Updated 2 months ago

Saved setup from just now

Will it work on macOS?

Yes, it runs on macOS

You'll build it yourself with Go, make.

Your system

macOS Windows Linux

Start here

Docs ↗doc.gfly.devLinked from the README.

Heads-upIt also needs 63 settings in .env (9 secret).

5 steps on macOS

Download setup.sh

Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.

1
Clone the repository
Needs Git: xcode-select --install
```
git clone https://github.com/JiveGroup/gFly.git
cd gFly
```
2
Install the required runtimes
Go 1.25.0, make
```
brew install go
xcode-select --install
```
3
Configure environment variables
Fill in secrets: SERVER_TLS_KEY, DB_PASSWORD, MAIL_PASSWORD, REDIS_PASSWORD, SESSION_KEY, JWT_SECRET_KEY, JWT_REFRESH_KEY, MEILISEARCH_MASTER_KEY
```
cp .env.example .env
```
4
Install dependencies
```
go mod download
```
5
Run the tests
```
go test ./...
```

From the README: Build and run command

# Build
make build

# Run command `db-test`
./build/artisan cmd:run db-test

Did you get it running?

No reports for macOS yet.

Still stuck? Get a written guide

GitManual AI Agent reads the 5 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.

Parts list

1×Go 1.25.0runtime
1×make tool

63× settings in .env

APP_NAME
APP_CODE
APP_ENV
APP_URL
APP_DEBUG
SERVER_HOST
SERVER_PORT
SERVER_TLS_CERT
SERVER_TLS_KEYsecret
STATIC_PATH
LOG_CHANNEL
LOG_FILE
LOG_LEVEL
API_PREFIX
API_VERSION
API_NAME
DB_DEBUG
DB_HOST
DB_PORT
DB_NAME
DB_USERNAME
DB_PASSWORDsecret
DB_SSL_MODE
DB_MAX_CONNECTION
DB_MAX_IDLE_CONNECTION
DB_MAX_LIFETIME_CONNECTION
DB_MAX_IDLE_TIME_CONNECTION
MAIL_PROTOCOL
MAIL_HOST
MAIL_PORT
MAIL_USERNAME
MAIL_PASSWORDsecret
MAIL_SENDER
MAIL_NAME
MAIL_TLS
REDIS_HOST
REDIS_PORT
REDIS_PASSWORDsecret
REDIS_DEFAULT_DB
REDIS_SESSION_DB
REDIS_QUEUE_DB
SESSION_KEYsecret
SESSION_TTL
SESSION_ID
VIEW_PATH
VIEW_EXT
STORAGE_DIR
APP_DIR
LOG_DIR
TEMP_DIR
FILESYSTEM_TYPE
NOTIFICATION_ENABLE
JWT_SECRET_KEYsecret
JWT_TTL_MINUTES
JWT_REFRESH_KEYsecret
JWT_TTL_OVER_DAYS
JWT_BLACKLIST
JWT_CHECK_BLACKLIST
ES_HOST
MEILISEARCH_HOST

Share this manual

Is this your repo?

Add a badge to your README so newcomers find these steps.

[![Setup manual](https://gitmanual.com/JiveGroup/gFly/badge.svg)](https://gitmanual.com/JiveGroup/gFly)

Good to know

Several programs live in cmd/ (console, web). Run one with go run ./cmd/<name>; the README says which is the app.

Details

License: Not detected
Open issues: 0
Branch: main

Files we read (5)

.env.example

.github/workflows/main.yml

Makefile

README.md

go.mod

215 files in the repo

Yes, it runs on macOS

Start here

5 steps on macOS

Clone the repository

Install the required runtimes

Configure environment variables

Install dependencies

Run the tests

From the README: Build and run command

Did you get it running?

Still stuck? Get a written guide