GRESB / api-docs

http://gresb.github.io/api-docs/
3 stars 0 forks source link

add steps to read.me for simple local setup #115

Closed joeyhorst closed 7 months ago

joeyhorst commented 1 year ago

Adding some steps to the read.me for easily setting up your machine. Mainly for QA to run locally and make changes.

I don't get it to work though 😒 @bartj3 when you have time could you have a look at it?

fixed in https://github.com/GRESB/api-docs/pull/116 --- After installing all the necessities running `docker compose up` fails on the `mini_racer` gem (Windows machine with WSL2/Ubuntu). ``` #0 219.8 In Gemfile: #0 219.8 mini_racer was resolved to 0.6.2, which depends on #0 219.8 libv8-node ------ failed to solve: executor failed running [/bin/sh -c bundle install]: exit code: 5 ``` Like in previous efforts I commented out... ``` # gem 'mini_racer' # ExecJS runtime ``` ...and installed NodeJS as a replacement for the JavaScript runtime. ``` sudo apt update sudo apt install nodejs ``` However running `docker compose up` still throws an error. ``` joeyhorst@joey-horst-msi-creator-z16:~/api-docs$ docker compose up [+] Running 2/0 â ¿ Network api-docs_default Created 0.0s â ¿ Container api-docs-middleman-1 Created 0.0s Attaching to api-docs-middleman-1 api-docs-middleman-1 | bundler: failed to load command: middleman (/usr/local/bundle/bin/middleman) api-docs-middleman-1 | ExecJS::RuntimeUnavailable: Could not find a JavaScript runtime. See https://github.com/rails/execjs for a list of available runtimes. api-docs-middleman-1 | /usr/local/bundle/gems/execjs-2.8.1/lib/execjs/runtimes.rb:58:in `autodetect' api-docs-middleman-1 | /usr/local/bundle/gems/execjs-2.8.1/lib/execjs.rb:5:in `' api-docs-middleman-1 | /usr/local/bundle/gems/execjs-2.8.1/lib/execjs.rb:4:in `' api-docs-middleman-1 | /usr/local/bundle/gems/activesupport-6.1.5/lib/active_support/dependencies.rb:332:in `require' api-docs-middleman-1 | /usr/local/bundle/gems/activesupport-6.1.5/lib/active_support/dependencies.rb:332:in `block in require' api-docs-middleman-1 | /usr/local/bundle/gems/activesupport-6.1.5/lib/active_support/dependencies.rb:299:in `load_dependency' api-docs-middleman-1 | /usr/local/bundle/gems/activesupport-6.1.5/lib/active_support/dependencies.rb:332:in `require' api-docs-middleman-1 | /usr/local/bundle/gems/coffee-script-2.4.1/lib/coffee_script.rb:1:in `' api-docs-middleman-1 | /usr/local/bundle/gems/activesupport-6.1.5/lib/active_support/dependencies.rb:332:in `require' api-docs-middleman-1 | /usr/local/bundle/gems/activesupport-6.1.5/lib/active_support/dependencies.rb:332:in `block in require' api-docs-middleman-1 | /usr/local/bundle/gems/activesupport-6.1.5/lib/active_support/dependencies.rb:299:in `load_dependency' api-docs-middleman-1 | /usr/local/bundle/gems/activesupport-6.1.5/lib/active_support/dependencies.rb:332:in `require' api-docs-middleman-1 | /usr/local/bundle/gems/middleman-core-4.4.2/lib/middleman-core/renderers/coffee_script.rb:2:in `' api-docs-middleman-1 | /usr/local/bundle/gems/activesupport-6.1.5/lib/active_support/dependencies.rb:332:in `require' api-docs-middleman-1 | /usr/local/bundle/gems/activesupport-6.1.5/lib/active_support/dependencies.rb:332:in `block in require' api-docs-middleman-1 | /usr/local/bundle/gems/activesupport-6.1.5/lib/active_support/dependencies.rb:299:in `load_dependency' api-docs-middleman-1 | /usr/local/bundle/gems/activesupport-6.1.5/lib/active_support/dependencies.rb:332:in `require' api-docs-middleman-1 | /usr/local/bundle/gems/middleman-core-4.4.2/lib/middleman-core/core_extensions/rendering.rb:11:in `block in ' api-docs-middleman-1 | /usr/local/bundle/gems/middleman-core-4.4.2/lib/middleman-core/extensions.rb:91:in `load' api-docs-middleman-1 | /usr/local/bundle/gems/middleman-core-4.4.2/lib/middleman-core/extensions.rb:127:in `block in load_settings' api-docs-middleman-1 | /usr/local/bundle/gems/middleman-core-4.4.2/lib/middleman-core/extensions.rb:125:in `each' api-docs-middleman-1 | /usr/local/bundle/gems/middleman-core-4.4.2/lib/middleman-core/extensions.rb:125:in `load_settings' api-docs-middleman-1 | /usr/local/bundle/gems/middleman-core-4.4.2/lib/middleman-core/extension_manager.rb:12:in `initialize' api-docs-middleman-1 | /usr/local/bundle/gems/middleman-core-4.4.2/lib/middleman-core/application.rb:263:in `new' api-docs-middleman-1 | /usr/local/bundle/gems/middleman-core-4.4.2/lib/middleman-core/application.rb:263:in `initialize' api-docs-middleman-1 | /usr/local/bundle/gems/middleman-cli-4.4.2/bin/middleman:49:in `new' api-docs-middleman-1 | /usr/local/bundle/gems/middleman-cli-4.4.2/bin/middleman:49:in `' api-docs-middleman-1 | /usr/local/bundle/bin/middleman:23:in `load' api-docs-middleman-1 | /usr/local/bundle/bin/middleman:23:in `' api-docs-middleman-1 exited with code 1 ```