REST API and MVC Starter Kit written in Crystal language.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
db
public
spec
src
.amber.yml
.gitignore
.travis.yml
Dockerfile
Procfile
README.md
docker-compose.yml
package-lock.json
package.json
shard.lock
shard.yml

README.md

CryRest

REST API and MVC Starter Kit written in Crystal language. This is a project written using Amber. Enjoy!

Getting Started

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

Prerequisites

This project requires Crystal, (installation guide).

Development

To start your Amber server:

  1. Install dependencies with shards install
  2. Build executables with shards build
  3. Create and migrate your database with bin/amber db create migrate. Also see creating the database.
  4. Start Amber server with bin/amber watch

Now you can visit http://localhost:3000/ from your browser.

Getting an error message you need help decoding? Check the Amber troubleshooting guide, post a tagged message on Stack Overflow, or visit Amber on Gitter.

Using Docker? Please check Amber Docker guides.

Tests

To run the test suite:

crystal spec

Build

  1. Build project with crystal build src/cry_rest.cr -o bin/cry_rest.

Deployment

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