https://github.com/faustinoaq/pet-tracker
Amber Framework demo for Quick Start guide
https://github.com/faustinoaq/pet-tracker
amber-framework crystal
Last synced: about 1 month ago
JSON representation
Amber Framework demo for Quick Start guide
- Host: GitHub
- URL: https://github.com/faustinoaq/pet-tracker
- Owner: faustinoaq
- Created: 2018-05-16T12:44:14.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-05-16T12:45:48.000Z (almost 8 years ago)
- Last Synced: 2025-02-13T11:33:02.705Z (about 1 year ago)
- Topics: amber-framework, crystal
- Language: Crystal
- Homepage: https://amberframework.gitbook.io/amber/getting-started/quick-start
- Size: 90.8 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# pet-tracker
This project is powered by [Amber Framework](https://amberframework.org/).
## Installation
1. [Install required dependencies](https://github.com/amberframework/online-docs/blob/master/getting-started/quickstart/zero-to-deploy.md#install-crystal-and-amber)
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](https://github.com/amberframework/online-docs/blob/master/getting-started/cli/encrypt.md#encrypt-command)
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](https://github.com/faustinoaq) Faustino Aguilar - creator, maintainer