amberframework

Version, currently master branch1 version
  • master branchlatestAug 13, 2026

github.com/amberframework/amberframework.org

Official website for Amber web application framework.

8 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  amberframework:
    github: amberframework/amberframework.org
    branch: master

master is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal
>= 1.20.0, < 2.0
License
MIT
Author
Amber <amberframework.org>
Target
  • amberframework from src/amberframework.cr

Dependencies

Runtime Dependencies

  • amber2.0.0-beta.5github: amberframework/amber
  • markd*github: icyleaf/markd
  • asset_pipeline~> 0.37.0github: amberframework/asset_pipeline

README

# Amber Framework Website

The Amber Framework website, running on Amber `2.0.0-beta.5` and ECR. The V2
public-beta experience includes versioned documentation, the project blog, and
the Amber brand system without a Node or Webpack runtime.

Amber CLI `2.0.6` is the minimum version for the database-backed web starter demonstrated on
the homepage and in the V2 guides.

## Local development

Requirements:

- Crystal 1.20 or newer (earlier than 2.0)
- Shards

```sh
shards install
crystal run scripts/build_assets.cr
amber watch
```

Open <http://localhost:3000>. Authored CSS, JavaScript, images, and fonts live in
`app/assets`; the build writes fingerprinted output to ignored
`public/assets`. No Node.js runtime, package manager, or bundler is required.

## Verification

```sh
crystal run scripts/build_assets.cr
crystal run scripts/build_assets.cr -- --check
crystal spec
scripts/check_v2_beta_docs.sh
scripts/check_v2_site_launch.sh
scripts/check_v2_preview.sh
```

## Production boundary

The production image compiles the site with Crystal 1.21 and runs the generated
`bin/amberframework` binary. DigitalOcean App Platform deploys `master` through
the root `Dockerfile`. Release evidence and the final gate status live in
`design/v2-preview/RELEASE_PROOF_BETA5.md` and
`design/v2-preview/RELEASE_GATES.md`.

```sh
docker compose up --build
```

## Contributing

1. Fork <https://github.com/amberframework/amberframework.org>.
2. Create a focused branch.
3. Run the verification commands above.
4. Open a pull request with desktop and mobile screenshots for visual changes.
5. Keep the CLI, framework pin, generated starter, and public documentation in
   one verified release contract.