Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update INSTALL to mention mounting the engine and running migrations #697

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update INSTALL to mention mounting the engine and running migrations #697

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@ You can then use the `calagator` command to generate a new Rails application wit

calagator new my_great_calendar
cd my_great_calendar

Once that's installed you'll just need to mount the engine where you'd like in your application. Update your config/routes.rb file in your newly generated Rails app and add a mount line for the engine wherever you'd like:

mount Calagator::Engine => '/events'

After you've mounted the engine go ahead and copy over the migration files and run migrations:

rake calagator:install:migrations
rails db:migrate

You should now be able to start your calendar in development mode with:

Expand Down Expand Up @@ -98,4 +107,4 @@ There are two places you'll want to customize right away. Both are *.html.erb fi
Feedback wanted
---------------

Is there something wrong, unclear, or outdated in this documentation? Please get in touch so we can make it better. If you can contribute improved text, we'd really appreciate it.
Is there something wrong, unclear, or outdated in this documentation? Please get in touch so we can make it better. If you can contribute improved text, we'd really appreciate it.