... | ... | @@ -14,7 +14,7 @@ We will be replacing the `awesim_rails` gem with the `ood_appkit` gem, and updat |
|
|
|
|
|
## Steps
|
|
|
|
|
|
#### 1. Clone the existing app to a directory under `/awesim/share`
|
|
|
#### 1. Clone the existing app to a directory under `/awesim/dev`
|
|
|
|
|
|
Do this through the dashboard web UI or via the shell on apps-test.awesim.org.
|
|
|
|
... | ... | @@ -66,11 +66,19 @@ i.e. `AwesimRails.dataroot` is replaced by `OodAppkit.dataroot`. The easy way to |
|
|
|
|
|
In Container Fill Sim, here is an example commit: https://github.com/AweSim-OSC/containerfillsim/pull/64/commits/5ee2a9f9289eccdc89782fa2d2cbd93dfa5d2bdd
|
|
|
|
|
|
#### 4. Delete `Gemfile.lock` and run bundler, and setup database
|
|
|
|
|
|
After completing these steps, delete the `Gemfile.lock` file and run `bundle install` from the dashboard web app or run this command:
|
|
|
|
|
|
scl enable rh-ruby22 nodejs010 -- bin/bundle install --path=vendor/bundle
|
|
|
|
|
|
#### 4. Update documentation if you have it to use /wiki instead of /docs
|
|
|
Then setup the database again:
|
|
|
|
|
|
scl enable rh-ruby22 nodejs010 -- bin/rake db:setup
|
|
|
|
|
|
Now you should be able to access your app and test.
|
|
|
|
|
|
#### 5. Make documentation accessible again (formerly at /docs, now at /wiki)
|
|
|
|
|
|
1. Clone the docs to /wiki
|
|
|
|
... | ... | @@ -89,42 +97,7 @@ After completing these steps, delete the `Gemfile.lock` file and run `bundle ins |
|
|
In Container Fill Sim, here is an example commit: https://github.com/AweSim-OSC/containerfillsim/pull/64/commits/e48f1bfcb4f1af5e4f97e05843523e14789f236b
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Note: if you do not wish to add the `awesim_branding` gem, you will need to update your application to use the application features in OodAppkit. See the [Diff Guide to removing the awesim_branding gem](https://github.com/AweSim-OSC/documentation/wiki/Port-an-existing-app-to-OOD#diff-guide-to-removing-the-awesim_branding-gem)
|
|
|
|
|
|
``
|
|
|
|
|
|
#### 3. Find all references to `AwesimRails` in the app code and modify to `OodAppkit`
|
|
|
|
|
|
##### Note particularly any references to `AwesimRails.dataroot`, which is now handled by `OodAppkit.dataroot`
|
|
|
|
|
|
Examples:
|
|
|
|
|
|
```diff
|
|
|
-outdir: File.join(AwesimRails.dataroot, "vnc", "paraview"),
|
|
|
+outdir: File.join(OodAppkit.dataroot, "vnc", "paraview"),
|
|
|
|
|
|
-Paperclip::Attachment.default_options[:path] = "#{AwesimRails.dataroot}/uploads/:class/:id/:created_at/:attachment/:filename"
|
|
|
+Paperclip::Attachment.default_options[:path] = "#{OodAppkit.dataroot}/uploads/:class/:id/:created_at/:attachment/:filename"
|
|
|
```
|
|
|
|
|
|
#### 4. Delete `Gemfile.lock`
|
|
|
|
|
|
#### 5. Run Bundler
|
|
|
|
|
|
```
|
|
|
$ scl enable git19 rh-ruby22 -- bin/bundle install --path=vendor/bundle
|
|
|
```
|
|
|
|
|
|
#### 6. Perform database migrations
|
|
|
|
|
|
```
|
|
|
$ scl enable git19 rh-ruby22 -- bin/rake db:setup RAILS_ENV=development
|
|
|
```
|
|
|
|
|
|
#### 7. Explicitly update status of jobs on each request
|
|
|
#### 6. Explicitly update status of jobs on each request
|
|
|
|
|
|
In v1.0.0 of osc_machete_rails we tried to auto-update the active jobs of all Statusable subclass instances. This hasn't worked reliably and will be removed in a future release. To undo this change:
|
|
|
|
... | ... | @@ -186,9 +159,13 @@ class SimulationsController < ApplicationController |
|
|
@simulation = @simulation.copy
|
|
|
```
|
|
|
|
|
|
## Test Changes
|
|
|
|
|
|
Test to make sure everything's working properly.
|
|
|
#### 7. Follow directions on app sharing
|
|
|
|
|
|
App sharing's setup setup now requires adding files that should be versioned with the app: https://github.com/AweSim-OSC/documentation/wiki/Sharing-apps-in-OOD#setup
|
|
|
|
|
|
Also, adding icons and manifest changes for app sharing are also documented https://github.com/AweSim-OSC/documentation/wiki/Sharing-apps-in-OOD
|
|
|
|
|
|
|
|
|
## Diff Guide to removing the `awesim_branding` gem.
|
|
|
|
... | ... | |