Getting Started

Quick Start
This quick start guide will help you get a full stack web application running in just a few minutes by leveraging amber’s code generators.
It will take us just 7 steps. Let’s get started!
Let’s get started!
1. Install dependencies
If you already have crystal, amber, and a database installed, you can skip this step.
1.1 Install crystal and amber
Instructions for OS X using Homebrew or MacPorts and Debian/Ubuntu are below. See full installation instructions here for RedHat & CentOS, ArchLinux & Derivatives, and more complete instructions.
macOS
Installing Amber with these package managers also installs Crystal.
Homebrew
1
brew tap amberframework/amber
2
brew install amber
Copied!
MacPorts
1
sudo port selfupdate
2
sudo port install amber
Copied!
Ubuntu or Debian
First install crystal (from the official install documentation):
1
curl -fsSL https://crystal-lang.org/install.sh | sudo bash
Copied!
Then install Amber (from source)
1
sudo apt-get install libreadline-dev libsqlite3-dev libpq-dev libmysqlclient-dev libssl-dev libyaml-dev libpcre3-dev libevent-dev
2
curl -L https://github.com/amberframework/amber/archive/stable.tar.gz | tar xz
3
cd amber-stable/
4
shards install
5
make install
Copied!
You can also install Amber with Linuxbrew​
1
brew tap amberframework/amber
2
brew install amber
Copied!
Above are the steps for building from source, the dependencies are specific to Ubuntu/Debian. See full installation instructions for other Linux Distributions.
1.2 Install a database
Amber works with postgresql (default), mysql, or sqlite.
If you don’t already have one of these installed, please follow the guides provided by each database maintainer:
​Postgresql Installation Guides​
​MySQL Installation Guides​
​Tutorial on installing SQLite​
On OS X any of the databases can be installed with brew install [database]
Docker users can opt to use a database container to develop with as well. By default, a new Amber application generates a docker-compose.yml that can be used for this purpose.
2. Generate a new Amber application
With all dependencies successfully installed, we can generate a new application with amber new
After the code for the new application is generated, we will cd into the new directory and execute a shards install.
The shards install command may take a little while - it has to download all shard dependencies.
The default setup will use a postgresql database, use -d mysql or -d sqlite for mysql and sqlite, respectively.
1
amber new pet-tracker
2
cd pet-tracker
Copied!
3. Generate a resource
With the skeleton application generated, we can generate our first RESTful resource.
The amber generate scaffold command will help us do this.
g is shorthand for generate
1
amber g scaffold Pet name:string breed:string age:integer
Copied!
4. Create and migrate the database
Generating the application and the scaffolded resource provides the configuration and migration files needed to set up the database.
amber db will help us do this, as you will see you can chain the db commands together.
1
amber db create migrate
Copied!
This will create a new database and run the migration to create a pets table with the specified columns.
5. Build the application and run the server
We can use amber watch to both build the binary application and start the server. Additionally, amber watch will detect code changes then recompile and restart the application automatically.
1
amber watch
Copied!
The watch commands will keep observing for file changes within the project and recompiling the application.
6. Use your brand new web application!
Open any browser and goto http://localhost:3000 You should see a home page load and “Pets” in the nav bar. If you click on the “Pets” link, you should be able to perform all seven RESTful actions for the “pets” resource.
7. Deploy your web application
Deployment
List of Commands
You can use these commands to create new awesome applications :-)
1
amber new pet-tracker
2
cd pet-tracker
3
shards install
4
amber generate scaffold Pet name:string breed:string age:integer
5
amber db create migrate
6
amber watch
Copied!
Demo
Here is the Quick Start demo app and the source code is available on Github.
Quick Start Demo
Guides

Introduction

Guides

Last modified 2mo ago

Copy link

Contents

Quick Start

1. Install dependencies

1.1 Install crystal and amber

1.2 Install a database

2. Generate a new Amber application

3. Generate a resource

4. Create and migrate the database

5. Build the application and run the server

6. Use your brand new web application!

7. Deploy your web application

List of Commands

Demo