Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/changjoo-park/amber-microblog

Microblog example using Amber Framework
https://github.com/changjoo-park/amber-microblog

amber amber-framework blog crystal

Last synced: about 1 month ago
JSON representation

Microblog example using Amber Framework

Awesome Lists containing this project

README

        

# microblog

[![Amber Framework](https://img.shields.io/badge/using-amber%20framework-orange.svg)](https://github.com/ChangJoo-Park/amber-microblog)

microblog is a new project using [Amber Framework](https://amberframework.org/)

## Installation

Install shard dependencies.

```
shards install
```

Configure the `config/environments/development.yml` and set the `database_url` with your credentials to your database.

Then:

```
amber db create migrate
```

## Usage

### Development

To run amber development server:

```
amber watch
```

### Production

To setup `AMBER_ENV`:

```
export AMBER_ENV=production
```

To build a production release:

```
shards build --production --release microblog
```

To build production assets:

```
npm run release
```

To use encrypted environment settings see [documentation](https://github.com/amberframework/online-docs/blob/master/getting-started/cli/encrypt.md#encrypt-command)

## Docker Compose

This will start an instance of mysql, 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

1. Fork it ( https://github.com/your-github-user/microblog/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

- [your-github-user](https://github.com/your-github-user) ChangJoo Park - creator, maintainer