Skip to content

les4sources/claudy

Repository files navigation

Claudy

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.

Ruby version

See .ruby-version and .tool-versions.

Tests

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.

Deployment

We deploy on a Akamai/Linode 2GB using Hatchbox. We will set a staging environment up on the same VPS once we start working collectively on the code.

Quick Start

Beforehand, get the encryption key for the development environment and add it to config/credentials/development.key.

git clone git@github.com:les4sources/claudy.git
cd claudy
bundle install
yarn install
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!

Seeding database

Use rails db:seed to add lodgings, rooms and spaces to the database.

Sending emails

Emails are delivered using Postmark. Please ask Michael (it@les4sources.be) for credentials.