Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Bean Validation website
branch: master
Failed to load latest commit information.
1.0 Adding news post about TCK releases; Updating version numbers on web …
1.1 Adding news post about TCK releases; Updating version numbers on web …
_config Move to Awestruct's Google Analytics Universal code
_ext Move to Awestruct's Google Analytics Universal code
_layouts Move to Awestruct's Google Analytics Universal code
contribute Fix <a ... /> usage
downloads Providing article on Bean Validation for download
images BVAL-479 Adding certified pages for BV 1.0 and 1.1
news Adding news post about TCK releases; Updating version numbers on web …
proposals Make proposals commentable
stylesheets Fix compass warnings
.awestruct_ignore Do not copy Rakefile, Gemfile and co in _site
.gitignore Add .bundle to gitignore
.htaccess Update issue tracker URL
404.html.haml Initial commit
Gemfile Upgrade to Awestruct 0.5.5
Gemfile.lock Upgrade to Awestruct 0.5.5
Guardfile BVAL-473 Adding Guardfile for live reload
README.md BVAL-480 Adding README.md to explain how to build the site
Rakefile Fix improper _bin usage in Rakefile
favicon.ico Initial commit
index.html.haml Fixing example listing on home page
licensing.md Adding missing brackets
roadmap.md Removing closed BVAL-222 issue from roadmap

README.md

How to build beanvalidation.org

A bit of Git, a bit of Ruby and you will get your local beanvalidation.org served.

Prerequisites

  • Get Git
  • Get a Ruby > 1.9
  • Get RVM to manage separate Ruby environments (optional - you should know what and why you do it)

Installation

Get the source

> git clone https://github.com/beanvalidation/beanvalidation.org.git
> cd beanvalidation.org

Rake

Make sure Rake is available. It is often installed per default.

> rake --version
rake, version 0.9.6

If you get command not found:

gem install rake

Bundler

Make sure Bundler is available. It manages your Ruby gems locally to the project and prevents version conflicts between different Ruby projects. To quote from the website:

Bundler provides a consistent environment for Ruby projects by tracking and installing the exact gems and versions that are needed.

> bundle -v
Bundler version 1.6.2

If you get command not found:

gem install bundler

Install dependencies

rake setup[local]
rake check

Serve the site locally

rake preview

Point your browser to http://localhost:4242

Tips & Tricks

Which other tasks exist in the Rake build file?

> rake --tasks

This will list the available tasks with a short description

I am getting errors when trying to execute awestruct directly

You need to use bundle exec <command> to make sure you get all required Gems. Check the Rakefile to see how the different awestruct calls are wrapped.

If your changes are not visible...

Panic! Then completely regenerate the site via:

rake clean preview

License

The content of this repository is released under the ASL 2.0.

By submitting a pull request or otherwise contributing to this repository, you agree to license your contribution under the respective licenses mentioned above.

Something went wrong with that request. Please try again.