https://github.com/changjoo-park/today-we-learned
WIP : Social today i learned
https://github.com/changjoo-park/today-we-learned
amber-framework today-i-learned
Last synced: 10 months ago
JSON representation
WIP : Social today i learned
- Host: GitHub
- URL: https://github.com/changjoo-park/today-we-learned
- Owner: ChangJoo-Park
- Created: 2018-01-31T14:31:48.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-02-02T10:08:26.000Z (over 8 years ago)
- Last Synced: 2025-04-03T12:19:17.983Z (about 1 year ago)
- Topics: amber-framework, today-i-learned
- Language: Crystal
- Homepage:
- Size: 148 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TODAY WE LEARNED
TODAY WE LEARNED 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 today-we-learned
```
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 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
1. Fork it ( https://github.com/changjoo-park/today-we-learned/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
- [changjoo-park](https://github.com/changjoo-park) ChangJoo Park - creator, maintainer