guides icon indicating copy to clipboard operation
guides copied to clipboard

Add `bundle install` step to the getting started guide

Open patrickbrown-dev opened this issue 1 year ago • 4 comments

When I was following the guide I had to do this step manually, and those who are newer to the Ruby ecosystem might not know this command is required before the bundle exec hanami dev command.

I hope this is helpful! Happy to change as needed! (Or maybe I did something wrong?)

Best, Pat

patrickbrown-dev avatar Aug 09 '24 03:08 patrickbrown-dev

Great find @patrickbrown-dev! Can you do the same for the 2.0 and 2.2 guides so we get this useful change for all recent versions?

cllns avatar Aug 09 '24 04:08 cllns

@cllns great idea! I'll update this PR!

patrickbrown-dev avatar Aug 09 '24 16:08 patrickbrown-dev

Hi @patrickbrown-dev, thanks for this suggestion!

hanami new should already run bundle install for you, so if you have to do this again manually, then I would consider that a bug with hanami new rather than a documentation issue to be fixed.

To this end, could you please have a go making a new app now and telling me if it actually still requires you to bundle install before running bundle exec hanami dev? And if so, any details about the output of hanami new would be useful to know too. This way we can get to the root cause and keep the experience best for all users.

timriley avatar Aug 11 '24 01:08 timriley

@timriley sorry for the delay! I'll take a look into this tonight!

patrickbrown-dev avatar Aug 14 '24 18:08 patrickbrown-dev

I think we should close this because as of at least Hanami 2.2.1 I couldn't reproduce:

➜  ~ gem install hanami
Successfully installed hanami-2.2.1
Parsing documentation for hanami-2.2.1
Installing ri documentation for hanami-2.2.1
Done installing documentation for hanami after 0 seconds
1 gem installed
➜  ~ hanami new bookshelf
Created bookshelf/
-> Within bookshelf/
Created .gitignore
Created .env
Created README.md
Created Gemfile
Created Rakefile
Created Procfile.dev
Created config.ru
Created bin/dev
Created config/app.rb
Created config/settings.rb
Created config/routes.rb
Created config/puma.rb
Created lib/tasks/.keep
Created lib/bookshelf/types.rb
Created app/actions/.keep
Created app/action.rb
Created app/view.rb
Created app/views/helpers.rb
Created app/templates/layouts/app.html.erb
Created package.json
Created config/assets.js
Created app/assets/js/app.js
Created app/assets/css/app.css
Created app/assets/images/favicon.ico
Created app/db/relation.rb
Created app/relations/.keep
Created app/db/repo.rb
Created app/repos/.keep
Created app/db/struct.rb
Created app/structs/.keep
Created config/db/seeds.rb
Created config/db/migrate/.keep
Created db/.keep
Created app/operation.rb
Created public/404.html
Created public/500.html
Running bundle install...
Running npm install...
Running hanami install...
➜  ~ cd bookshelf 
➜  bookshelf bundle exec hanami dev
18:17:47 web.1    | started with pid 53404

But please do reopen if this is an issue for anyone else!

parndt avatar Oct 19 '25 07:10 parndt