https://github.com/waiting-for-dev/hanami_app
https://github.com/waiting-for-dev/hanami_app
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/waiting-for-dev/hanami_app
- Owner: waiting-for-dev
- Created: 2021-05-03T04:49:15.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-03T05:22:59.000Z (about 5 years ago)
- Last Synced: 2025-03-04T11:43:24.389Z (over 1 year ago)
- Language: Ruby
- Size: 25.4 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.app.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# AppPrototype
This is a Hanami 2 application.
## Docker development
To bootstrap and setup the app and its assets server, just run:
```
script/setup docker
```
To start the app:
```
docker compose up app
```
## Local development
### Requirements
The scripts below require [Homebrew][brew] and [asdf][asdf] installed, and
[asdf added to your shell][asdf-shell].
If you prefer different tools, remove `Brewfile` and `.tool-versions`, and adapt
the `script/` files (mentioned below) to use your preferred tools.
[brew]: https://brew.sh
[asdf]: https://asdf-vm.com
[asdf-shell]: https://asdf-vm.com/#/core-manage-asdf-vm?id=add-to-your-shell
### Local setup
After cloning, run:
```
./script/bootstrap
```
#### Running supporting services
To start the supporting services, run:
```
./script/support
```
These must be running before completing the following steps.
#### Setup
After the supporting services have started, run:
```
./script/setup
```
### After pulling changes
After pulling changes from the remote, run:
```
./script/update
```
#### Running the app
To run the app:
```
./script/server
```
This launches the application processes using [overmind][overmind], which places
each into a [tmux][tmux] session. You can connect to a specific process to
interact with it (which is useful when using an interactive debugger inside the
`web` process):
```
overmind c web
```
⚠️ To detatch from the tmux session, use the
ctrl+b,d shortcut.
[overmind]: https://github.com/DarthSim/overmind
[tmux]: https://thoughtbot.com/blog/a-tmux-crash-course