Skip to content

MLSDev/crystal_amber_backend_example

Repository files navigation

Amber Backend

Amber Framework

This is a project written using Amber for testing and purposes like that. Enjoy!

Getting Started

These instructions will get a copy of this project running on your machine for development and testing purposes.

Please see deployment for notes on deploying the project in production.

Prerequisites

This project requires Crystal (installation guide).

Development

To start your Amber server:

  1. Install dependencies with shards install
  2. Prepare development.yml using sample at development.yml.example
  3. Build executables with shards build
  4. Create and migrate your database with bin/amber db create migrate. Also see creating the database.
  5. Start Amber server with bin/amber watch

Tests

To run the test suite:

crystal spec

Contributing

  1. Fork it ( https://github.com/MLSDev/crystal_amber_backend_example/fork )
  2. Create your feature branch ( git checkout -b my-new-feature )
  3. Commit your changes ( git commit -am 'Add some feature' )
  4. Push to the branch ( git push origin my-new-feature )
  5. Create a new Pull Request

Contributors