This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
Ruby version
-
System dependencies
-
Configuration
-
Database creation
-
Database initialization
-
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
-
Development instructions
npm i
bin/dev
# run once for engine's propshaft to work:
bin/rails assets:precompile
bin/rails assets:clobber- Troubleshooting
# Debugging Rails console
RUBY_DEBUG_OPEN=true bin/rails c
# Clear cache
bin/rails assets:clobber- Deployment instructions
NOTE: for error "requireStack: [ '/rails/node_modules/rollup/dist/native.js' ]", optional rollup dependency required for Vite in production (https://stackoverflow.com/questions/77569907/error-in-react-vite-project-due-to-rollup-dependency-module-not-found).
# NOTE: setup Docker if not already provisioned
# kamal setup
# NOTE: ran as pre-build hook
# mkdir -p /home/ubuntu/rails_storage
# sudo chown -R ubuntu:ubuntu /home/ubuntu/rails_storage
# sudo chmod -R 777 /home/ubuntu/rails_storage
# (Optional) Build accessories
cd longvu_pg && ./build.sh
kamal accessory remove longvu_pg
kamal accessory boot longvu_pg
# Build app
# NOTE: commit changes in Git if deploy builder context is not .
# NOTE: (to fix permission issue) COPY --chmod=755 --from=build /rails /rails
kamal deploy- ...