Girder

Development

# BackEnd
docker compose up

# FrontEnd
nvm use
yarn install
yarn run dev

Visit http://localhost:7000/

For more detail on how the frontend works, see the frontend README.

Sidekiq

Sidekiq client doesn't run by default, so any enqueued jobs just wait in the queue to be processed.

You can start Sidekiq with:

bin/app run bundle exec sidekiq

Test

# BackEnd Tests (requires backend running)
bin/app rspec

# FrontEnd Tests
yarn run test

Code Formatting & Linting

# Run linters
yarn run prettier
yarn run lint:ruby
yarn run lint:js
yarn run lint:css

# Auto-fix any issues
yarn run prettier:fix
yarn run lint:ruby:fix
yarn run lint:js:fix
yarn run lint:css:fix