4hv.org

Overview

A full-featured forum application built with Ruby on Rails.

Prerequisites

Before setting up the project, ensure you have the following installed:

• Ruby (via rvm or rbenv)
• Bundler (gem install bundler)
• PostgreSQL (via Homebrew or Postgres.app)
• Redis (for caching and background jobs)

Setup

Ruby Installation

brew install rvm
rvm install $(cat .ruby-version)
rvm use

Dependencies

Install project dependencies:

bundle install

Database Setup

Create and initialize the PostgreSQL database:

bundle exec rails db:create
bundle exec rails db:migrate
bundle exec rails db:seed

For a fresh start:

rails db:drop db:create db:schema:load db:migrate db:seed

Development

Start the Rails server in development mode:

rails server
# or
rails s

Access the Rails console:

rails console
# or
rails c

The application will be available at http://localhost:3000.

For additional commands and options, please refer to the Makefile.

Testing

Run the full test suite:

rails rspec

Run specific tests:

# Run all tests in a specific file
rspec spec/controllers/user_controller_spec.rb
# Run a specific test
rspec spec/controllers/user_controller_spec.rb:32

Utility Commands

For additional commands and options, please refer to the Makefile.

Contributing

We welcome contributions! Please see our contribution guidelines for details on how to get involved.

License

This project is licensed under the MIT License. See LICENSE for details.

Disclaimer

This software is currently in alpha development and should be used with caution. Features and APIs may change as development continues. Your feedback is valuable and appreciated!

---