projectforge

README

Project Forge

Project Forge is an application that allows you to generate, manage, and grow web applications built using the Go programming language. You control your application's features, provided via "modules" that enable everything from databases to OAuth. When creating a new application with Project Forge, a standard Golang project is created, which includes utilities and APIs to help you build the application you want, without compromise.

All projects managed by Project Forge provide an HTTP server using quicktemplate for HTML templates (and SQL, if enabled). An MVC framework is provided (but not required) that handles content negotiation, hierarchical menus, breadcrumbs, OAuth to dozens of providers, stateless user profiles, dark mode support, SVG management, syntax highlighting, form components, and embedded assets.

Project Forge applications can support any UI framework, but the included UI renders a JS-dependency-free page, heavily optimized for speed and accessibility, with a modern UX that works surprisingly well without JavaScript. The about page is animated, themed, and responsive, and only creates three requests (HTML, CSS, JS) totaling less than 20KB zipped. It serves in less than a millisecond, and renders in Chrome in less than 20ms. Progressive enhancement is provided by an included ESBuild TypeScript project, though all functionality is supported with JavaScript disabled.

Your application can (optionally) build for every platform; desktop and mobile webview apps, WASM, and notarized universal macOS binaries. If you enable all the build options, it will produce almost 60 builds for various platforms. They all produce a ~20MB native binary. The binaries produced can be configured to auto-upgrade from GitHub Releases, or be upgraded by the user using a CLI or UI (module "upgrade" must be in your project). CI/CD workflows based on GitHub Actions are provided, handling building, testing, linting, and publishing to GitHub Releases (and any configured Docker repos).

Download

https://projectforge.dev/download

Source code

https://github.com/kyleu/projectforge

App Features

A project managed by Project Forge...

• Has a beautiful and fast HTML UI, no JavaScript required
• Optimizes for speed and developer experience, sub-second turnaround times
• Builds in seconds, live-reloads in dev mode when code or templates change
• Builds native apps for dozens of platforms; mobile, desktop, weird architectures, macOS universal apps
• Produces a small self-contained binary, includes full REST server and command line interface
• Optionally supports OAuth with dozens of providers, full theme and stateless session support
• Provides a type-safe API for working with PostgreSQL, MySQL, and SQLite databases (or no database at all)
• Uses ESBuild for a TypeScript client with progressive enhancement, embedded SVGs, and modern CSS

Example Applications

• Rituals.dev (GitHub): Work with your team to estimate work, track your progress, and gather feedback.

  • It's a full websocket-driven rich client application, but also works fine without JavaScript

• TODO Forge (GitHub): Manages collections of todo items.

  • Almost entirely generated using Project Forge, this is a "stock" application

• Load Toad (GitHub): A tool for uploading HTTP Archives (.har files) and running load tests.

  • Also supports client-defined JavaScript, executed in-process on the server

• Admini (GitHub): A database management application, basically. It does other stuff too.

  • This one is weird, it tried to build a user-defined admin app, but it just ended up looking like a 1990's web portal

• NPN (GitHub): Basically Postman, it helps you explore and test HTTP services with a focus on speed and correctness.

  • This uses a Vue.js-based rich client application, and a websocket to handle communication

• Solitaire (GitHub): An example game, not really anything right now.

  • It mainly exists as a testbed for me, and to show the features of Project Forge projects

More examples coming soon...

Documentation

• Installation
• Contributing
• Customizing
• Releasing
• Running
• Scripts
• Technology

Licensing

The Project Forge application is released under MIT license, and all modules are CC0.