Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.63 KB

README.md

File metadata and controls

48 lines (32 loc) · 1.63 KB
Raw

rspec.github.io

Source for https://rspec.info

Requires a recent version of Ruby (tested on 2.7.5, Ruby 3.x is not yet working), bundler and imagemagick (to generate favicons).

Local Setup

  • brew install imagemagick (or your package manager of choice).
  • brew install nodejs (or your javascript runtime of choice for execjs).
  • bundle install
  • middleman build

Local Developing

Run LIVERELOAD=true middleman server

Docker Setup + Development

If you don't have a local Ruby environment suitable to making changes to rspec.info, or prefer containerised development; use the following scripts to build the included Docker image and build the site in the containerised environment instead.

# Start the middleman server. Access site at http://localhost:4567
bin/server

# Build the site in the `docs/` directory. Replacement for `middleman build`.
bin/build

# Start a console inside the docker container. Useful for debugging or running commands locally.
bin/console

Deploying

We now use the Github action in .github/workflows/middleman_deploy.yml to automatically build and deploy, builds are run on PR to ensure they "work" but you should check the artifacts locally / in the build before merging.

Credits

Andrew Harvey - for his incredible effort of making this repository as it is now