gopostulate_dev

module
v0.0.0-...-b3e6d50 Latest Latest
Warning

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

Go to latest
Published: Aug 18, 2024 License: MIT

README

Titmouse

Note: This project is currently in the very early stages of development and is not yet ready for use of any kind.

Titmiuse is a full-stack web application framework inspired by NextJS, leveraging the power of Go and complementary technologies. It is designed to facilitate the rapid development of performant, Server-Side Rendered (SSR) Single Page Applications (SPA) with dynamic capabilities.

Core Technologies

  • Go: The primary language for backend development
  • Gorm: Object-Relational Mapping (ORM) for database interactions
  • Gin: High-performance HTTP web framework
  • Templ: Typed templating language for Go
  • Typed-HTMx-Go: Type-safe Go bindings for HTMX
  • TypeScript: For additional frontend logic
  • ESBuild: Fast JavaScript bundler and minifier

Key Features

  • File-based routing system similar to NextJS
  • Integrated CLI for project scaffolding and management
  • Built-in development server with hot reloading
  • Streamlined production build process
  • Type-safe templating with Templ
  • Efficient asset management and bundling with ESBuild
  • Database integration with Gorm
  • HTMX integration for dynamic frontend updates without full page reloads

Quick Start

To create a new GoPostulate project:

go run cmd/titmouse/main.go new --name my-project
cd my-project
go run cmd/app/main.go

Project Structure

Titmouse provides a standardized project structure to help you organize your code effectively:

my-project/
├── cmd/
├── internal/
├── web/
├── migrations/
├── app/
├── tests/
├── go.mod
└── .gitignore

For more details on the project structure and how to use Titmouse, please refer to our Getting Started Guide.

Documentation

For more detailed information, please refer to the documentation in the docs/ directory:

Contributing

We welcome contributions! Please see our Contributing Guide for more details.

License

Titmouse is released under the MIT License.

Directories

Path Synopsis
cmd
gopostulate command
Package main is the CLI entry point for the gopostulate framework
Package main is the CLI entry point for the gopostulate framework
internal
build
Package build provides asset processing utilities
Package build provides asset processing utilities
cli
internal/cli/build.go
internal/cli/build.go
config
Package config manages the framework configuration
Package config manages the framework configuration
generator
Package generator provides functionality for component template generation
Package generator provides functionality for component template generation
pkg
middleware
Package middleware provides common middleware for use in gopostulate projects
Package middleware provides common middleware for use in gopostulate projects
template
internal/template/engine.go
internal/template/engine.go
templates

Jump to

Keyboard shortcuts

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