goship

(★ 457)

Opinionated Go + HTMX framework for shipping production apps fast ⛵️

File Explorer

Download Latest Version (.zip)

- - test.yml
- - post-deploy.sample
  - post-traefik-reboot.sample
  - pre-build.sample
  - pre-connect.sample
  - pre-deploy.sample
  - pre-traefik-reboot.sample
- extensions.json
- settings.json
- tailwind.json
- - main.go
- - main.go
- - main.go
- - accessories.sh
  - web-app.sh
  - worker.sh
- config.go
- config.yaml
- config_test.go
- - deploy.yml
- - goship.spec.ts
  - helper.ts
- config.js
- package-lock.json
- package.json
- playwright.config.ts
- - emailsubscription.go
  - where.go
- - emailsubscriptiontype.go
  - where.go
- - emojis.go
  - where.go
- - enttest.go
- - fcmsubscriptions.go
  - where.go
- - filestorage.go
  - where.go
- - custom_hook.go
  - hook.go
- - image.go
  - where.go
- - imagesize.go
  - where.go
- - invitation.go
  - where.go
- - lastseenonline.go
  - where.go
- - migrate.go
  - schema.go
- - monthlysubscription.go
  - where.go
- - notification.go
  - where.go
- - notificationpermission.go
  - where.go
- - notificationtime.go
  - where.go
- - passwordtoken.go
  - where.go
- - phoneverificationcode.go
  - where.go
- - predicate.go
- - profile.go
  - where.go
- - pwapushsubscription.go
  - where.go
- - runtime.go
- - emailsubscription.go
  - emailsubscriptiontype.go
  - emojis.go
  - fcmsubscriptions.go
  - filestorage.go
  - image.go
  - imagesize.go
  - invitation.go
  - lastseenonline.go
  - mixin.go
  - monthlysubscription.go
  - notification.go
  - notificationpermission.go
  - notificationtime.go
  - passwordtoken.go
  - phoneverificationcode.go
  - profile.go
  - pwapushsubscription.go
  - sentemail.go
  - user.go
- - sentemail.go
  - where.go
- - user.go
  - where.go
- client.go
- emailsubscription.go
- emailsubscription_create.go
- emailsubscription_delete.go
- emailsubscription_query.go
- emailsubscription_update.go
- emailsubscriptiontype.go
- emailsubscriptiontype_create.go
- emailsubscriptiontype_delete.go
- emailsubscriptiontype_query.go
- emailsubscriptiontype_update.go
- emojis.go
- emojis_create.go
- emojis_delete.go
- emojis_query.go
- emojis_update.go
- ent.go
- fcmsubscriptions.go
- fcmsubscriptions_create.go
- fcmsubscriptions_delete.go
- fcmsubscriptions_query.go
- fcmsubscriptions_update.go
- filestorage.go
- filestorage_create.go
- filestorage_delete.go
- filestorage_query.go
- filestorage_update.go
- generate.go
- image.go
- image_create.go
- image_delete.go
- image_query.go
- image_update.go
- imagesize.go
- imagesize_create.go
- imagesize_delete.go
- imagesize_query.go
- imagesize_update.go
- invitation.go
- invitation_create.go
- invitation_delete.go
- invitation_query.go
- invitation_update.go
- lastseenonline.go
- lastseenonline_create.go
- lastseenonline_delete.go
- lastseenonline_query.go
- lastseenonline_update.go
- monthlysubscription.go
- monthlysubscription_create.go
- monthlysubscription_delete.go
- monthlysubscription_query.go
- monthlysubscription_update.go
- mutation.go
- notification.go
- notification_create.go
- notification_delete.go
- notification_query.go
- notification_update.go
- notificationpermission.go
- notificationpermission_create.go
- notificationpermission_delete.go
- notificationpermission_query.go
- notificationpermission_update.go
- notificationtime.go
- notificationtime_create.go
- notificationtime_delete.go
- notificationtime_query.go
- notificationtime_update.go
- passwordtoken.go
- passwordtoken_create.go
- passwordtoken_delete.go
- passwordtoken_query.go
- passwordtoken_update.go
- phoneverificationcode.go
- phoneverificationcode_create.go
- phoneverificationcode_delete.go
- phoneverificationcode_query.go
- phoneverificationcode_update.go
- profile.go
- profile_create.go
- profile_delete.go
- profile_query.go
- profile_update.go
- pwapushsubscription.go
- pwapushsubscription_create.go
- pwapushsubscription_delete.go
- pwapushsubscription_query.go
- pwapushsubscription_update.go
- runtime.go
- sentemail.go
- sentemail_create.go
- sentemail_delete.go
- sentemail_query.go
- sentemail_update.go
- tx.go
- user.go
- user_create.go
- user_delete.go
- user_query.go
- user_update.go
- - main.js
- - cal_heatmap.js
  - load_scripts_and_styles.js
  - main.js
  - test_quiz.js
- Dockerfile
- init_pgvector.sh
- - context.go
  - context_test.go
- - controller.go
  - controller_test.go
  - form.go
  - form_test.go
  - page.go
  - page_test.go
  - pager.go
  - pager_test.go
- - constants.go
  - enum.go
  - maps.go
  - struct.go
- - funcmap.go
  - funcmap_test.go
- - htmx.go
  - htmx_test.go
- - auth.go
  - auth_test.go
  - cache.go
  - cache_test.go
  - device.go
  - entity.go
  - entity_test.go
  - lastseenonline.go
  - log.go
  - log_test.go
  - middleware_test.go
  - onboarding.go
  - sentry.go
- - auth.go
  - auth_test.go
  - cache.go
  - cache_test.go
  - container.go
  - container_test.go
  - services_test.go
  - tasks.go
  - tasks_test.go
  - validator.go
  - validator_test.go
- - mail.go
  - notifications.go
  - subscriptions.go
- - tests.go
- - about.go
  - committed.go
  - contact.go
  - email_subscribe.go
  - emails.go
  - forgot_password.go
  - home.go
  - home_feed.go
  - invitations.go
  - landing_page.go
  - login.go
  - notifications.go
  - page_data.go
  - payments.go
  - preferences.go
  - profile.go
  - register.go
  - reset_password.go
  - search.go
- - .gitignore
  - launch-128.png
  - launch-192.png
  - launch-256.png
  - launch-512.png
  - launch-64.png
  - LICENSE
  - Podfile
- next-steps.html
- regen_logo_images.py
- requirements.txt
- seeder.go
- seeder_test.go
- cherie_pwa_apple-icon-180.png
- cherie_pwa_manifest-icon-192.maskable.png
- cherie_pwa_manifest-icon-512.maskable.png
- cherie_pwa_manifest-icon-96.maskable.png
- favicon.png
- icon.png
- main.css
- main.css.map
- main.js
- main.js.map
- manifest.json
- meta_main.json
- meta_svelte_bundle.json
- meta_vanilla_bundle.json
- styles_bundle.css
- svelte_bundle.css
- svelte_bundle.css.map
- svelte_bundle.js
- svelte_bundle.js.map
- vanilla_bundle.js
- vanilla_bundle.js.map
- styles.css
- tailwind_components.css
- - accordion.templ
  - accordion_templ.go
  - auth.templ
  - auth_templ.go
  - bottom_nav.templ
  - bottom_nav_templ.go
  - core.templ
  - core_templ.go
  - documentation.templ
  - documentation_templ.go
  - drawer.templ
  - drawer_templ.go
  - empty_page_msg.templ
  - empty_page_msg_templ.go
  - forms.templ
  - forms_templ.go
  - heatmap.templ
  - heatmap_templ.go
  - icons.templ
  - icons_templ.go
  - loading.templ
  - loading_templ.go
  - logos.templ
  - logos_templ.go
  - messages.templ
  - messages_templ.go
  - navbar.templ
  - navbar_templ.go
  - payments.templ
  - payments_templ.go
  - permissions.templ
  - permissions_templ.go
  - prev_nav.templ
  - prev_nav_templ.go
  - profile.templ
  - profile_templ.go
  - pwa_install.templ
  - pwa_install_templ.go
  - sidebar.templ
  - sidebar_templ.go
  - theme_toggle.templ
  - theme_toggle_templ.go
  - tooltip.templ
  - tooltip_templ.go
  - top_banner.templ
  - top_banner_templ.go
- - password_reset.templ
  - password_reset_templ.go
  - registration_confirmation.templ
  - registration_confirmation_templ.go
  - subscription_confirmation.templ
  - subscription_confirmation_templ.go
  - test.templ
  - test_templ.go
  - update.templ
  - update_templ.go
- - helpers.templ
  - helpers_templ.go
- - auth.templ
  - auth_templ.go
  - documentation.templ
  - documentation_templ.go
  - email.templ
  - email_templ.go
  - landing_page.templ
  - landing_page_templ.go
  - main.templ
  - main_templ.go
- - about.templ
  - about_templ.go
  - contact.templ
  - contact_templ.go
  - delete_account.templ
  - delete_account_templ.go
  - docs_architecture.templ
  - docs_architecture_templ.go
  - docs_emails.templ
  - docs_emails_templ.go
  - documentation.templ
  - documentation_templ.go
  - email_subscribe.templ
  - email_subscribe_templ.go
  - error.templ
  - error_templ.go
  - forgot_password.templ
  - forgot_password_templ.go
  - healthcheck.templ
  - healthcheck_templ.go
  - home.templ
  - home_feed.templ
  - home_feed_templ.go
  - home_templ.go
  - install_app.templ
  - install_app_templ.go
  - invitations.templ
  - invitations_templ.go
  - landing_page.templ
  - landing_page_templ.go
  - login.templ
  - login_templ.go
  - notifications.templ
  - notifications_templ.go
  - payments.templ
  - payments_templ.go
  - phone.templ
  - phone_templ.go
  - preferences.templ
  - preferences_templ.go
  - privacy_policy.templ
  - privacy_policy_templ.go
  - profile.templ
  - profile_templ.go
  - register.templ
  - register_templ.go
  - reset_password.templ
  - reset_password_templ.go
- templates.go
- - 1.jpg
  - 2.jpg
.air.toml
.dockerignore
.env.dev
.gitattributes
.gitignore
build.mjs
docker-compose.yml
Dockerfile
entrypoint.sh
go.mod
go.sum
LICENSE
Makefile
package-lock.json
package.json
Procfile
README.md
service-worker.js
tailwind.config.js
tsconfig.json

# Installation Guide

1. Get the code

git clone https://github.com/leomorpho/goship

Downloads the entire project code from GitHub to your computer.

cd goship

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

|-- docker-compose.yml # Docker compose file for running the project locally with Docker Desktop

Runs the command against the services defined in the compose file.

make up # Starts the docker containers

Compiles the code based on the generated build configuration to produce an executable.

make down # Stops the docker containers

Compiles the code based on the generated build configuration to produce an executable.

make down-volume # Stops the docker containers and removes the volumes

Compiles the code based on the generated build configuration to produce an executable.

make reset # Stops the docker containers and removes the volumes, then rebuilds the docker containers

Compiles the code based on the generated build configuration to produce an executable.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

cd e2e_tests

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

python3 -m venv .venv

Runs the Python script (or module).

pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

5. Go

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Go The Go compiler and toolchain.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

✅ If the build finishes without errors, it worked. If you used go run ., check the terminal output.

6. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make init

Compiles the code based on the generated build configuration to produce an executable.

make watch

Compiles the code based on the generated build configuration to produce an executable.

make init # Initializes the project

Compiles the code based on the generated build configuration to produce an executable.

make watch # Runs the project in watch mode, rebuilding assets as you go (JS, CSS, Templ, etc)

Compiles the code based on the generated build configuration to produce an executable.

make test # Runs the tests

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

goship

File Explorer

# Installation Guide

2. Docker

3. Node.js

4. Python

5. Go

6. Make

Today's picks

Was this content helpful?

Recent Feedback

goship

File Explorer

# Installation Guide

2. Docker

3. Node.js

4. Python

5. Go

6. Make

Today's picks

Was this content helpful?

Recent Feedback

Download README