snowflake

command module
v0.2.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 10, 2024 License: MIT Imports: 1 Imported by: 0

README

Snowflake

Yet another Go web application generator.

Features:

  • Opinionated with the best practices.
  • Simplicity with batteries.
  • Idiomatic. Every Gopher loves that word.

Installation

go install github.com/gitkumi/snowflake@latest

Quick Start

Here is how to generate a web application with sqlite3 as database.

snowflake new -t web -d sqlite3 acme

Flags

  • type (-t)

    • web - Generates a web application that serves HTML. (Requires Node.js 20.x and pnpm)
    • api - Generates a RESTful API application.
  • database (-d)

    • sqlite3
    • postgres
    • mysql

Stack

Snowflake is built with these packages. Make sure to check their documentation.

Dev
Routing
Database
Front-end (Web only)

Make Commands

  • make dev - Start the development environment with hot reload.
  • make test - Run tests.
  • make build - Build the project.
  • make run - Run the build.
  • make db - Check database status.
  • make up - Run database migration.
  • make down - Roll back database migration by 1.
  • make reset - Roll back all migration.
  • make create <table_name> - Create an empty migration file.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL