Claudy is the in-house web application for Les 4 Sources, a foundation whose activities are run by a collective of families living in Yvoir, Belgium, at the Domaine d'Ahinvaux. Read more in the wiki.
It is built on Ruby on Rails 7 and PostgreSQL.
See .ruby-version and .tool-versions.
There are no tests for now, but we want to introduce a test suite with the upcoming Spaces refactoring (see #8). Feel free to start using any test system that you feel comfortable with.
We deploy on a Akamai/Linode 2GB using Hatchbox. We might set a staging environment up on the same VPS once we start working collectively on the code.
Beforehand, get the encryption key for the development
environment and add it to config/credentials/development.key
.
Then install Ruby 3.1.2 and NodeJS 18.8.0.
Get the default environment variables values and add them to .env
, or - for now - duplicate .env.example
to .env
.
And everything should go like a couque.
git clone [email protected]:les4sources/claudy.git
cd claudy
gem install bundler:2.3.19
bundle config build.nio4r --with-cflags="-Wno-incompatible-pointer-types"
bundle install
yarn install
brew install vips
rails db:create && rails db:migrate
rails db:seed
bin/vite dev &
rails s
Then use the Rails console to add a first user.
> User.create email: "[set email here]", password: "[set password here]"
You are ready to go! Open localhost:3000 and have fun!
Use rails db:seed
to add lodgings, rooms and spaces to the database.
Emails are delivered using Postmark. Please ask Michael ([email protected]) for credentials.