apidemo

master branch1 version

master branchlatestSep 10, 2017

github.com/quimeo/apidemo

Demo for new API with https://amberframework.org/

0 stars

0 dependents

License: UNLICENSED

Installation

# Add this to your shard.yml
dependencies:
  apidemo:
    github: quimeo/apidemo
    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

0.23.1

License

UNLICENSED

Author

Amber

Targets

amber from lib/amber/src/amber/cli.cr
apidemo from src/apidemo.cr

Dependencies

Runtime Dependencies

pg*github: will/crystal-pg
amber*github: amber-crystal/amber
granite_orm*github: amber-crystal/granite-orm
quartz-mailer*github: amber-crystal/quartz-mailer
jasper_helpers*github: amber-crystal/jasper-helpers

Development Dependencies

amber_spec*github: amber-crystal/amber-specdev

README

apidemo

Your description here

Installation

Create a pg database called apidemo_development and configure the config/database.yml to provide the credentials to access the table.

Then:

shards update
amber migrate up

Usage

To run the demo:

$ shards build src/apidemo.cr
./apidemo

Docker Compose

This will start an instance of postgres, migrate the database, and launch the site at http://localhost:3000

docker-compose up -d

To view the logs:

docker-compose logs -f

Note: The Docker images are compatible with Heroku.

Contributing

Fork it ( https://github.com/[your-github-name]/your_project/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new Pull Request

Contributors

your_github_name your_name - creator, maintainer

apidemo

Installation

shard.yml

Dependencies

Runtime Dependencies

Development Dependencies

README

apidemo

Installation

Usage

Docker Compose

Contributing

Contributors

Documentation

Links

This branch

Dependents

Repository

Metadata