pet-tracker

Version, currently master branch1 version
  • master branchlatestMay 16, 2018

github.com/faustinoaq/pet-tracker

Amber Framework demo for Quick Start guide

5 stars
0 dependents
License: UNLICENSED

Installation

# Add this to your shard.yml
dependencies:
  pet-tracker:
    github: faustinoaq/pet-tracker
    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.24.2
License
UNLICENSED
Author
Faustino Aguilar
Targets
  • amber from lib/amber/src/amber/cli.cr
  • pet-tracker from src/pet-tracker.cr

Dependencies

Runtime Dependencies

  • pg~> 0.14.1github: will/crystal-pg
  • amber0.7.2github: amberframework/amber
  • granite_orm~> 0.8.4github: amberframework/granite-orm
  • citrine-i18n0.1.0github: amberframework/citrine-i18n
  • quartz_mailer~> 0.5.1github: amberframework/quartz-mailer
  • jasper_helpers~> 0.2.0github: amberframework/jasper-helpers

Development Dependencies

  • garnet_spec~> 0.1.1github: amberframework/garnet-specdev

README

pet-tracker

This project is powered by Amber Framework.

Installation

  1. Install required dependencies
  2. Run shards install

Usage

To setup your database edit database_url inside config/environments/development.yml file.

To edit your production settings use amber encrypt. See encrypt command guide

To run amber server in a development enviroment:

amber db create migrate
amber watch

To build and run a production release:

  1. Add an environment variable AMBER_ENV with a value of production
  2. Run these commands (Note using --release is optional and may take a long time):
npm run release
amber db create migrate
shards build --production --release
./bin/pet-tracker

Docker Compose

To set up the database and launch the server:

docker-compose up -d

To view the logs:

docker-compose logs -f

Note: The Docker images are compatible with Heroku.

Contributing

  1. Fork it ( https://github.com/faustinoaq/pet-tracker/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

  • faustinoaq Faustino Aguilar - creator, maintainer