Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Complete rebuild of the 4hv.org forums from the ground up.

License

Notifications You must be signed in to change notification settings

HarrisFauntleroy/4hv.org

Repository files navigation

Forum

Code style Coverage GitHub contributors GitHub branch checks state GitHub issues GitHub issues GitHub issues

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

Table of Contents ⚙️

  1. Features
  2. Local Development
  3. Contributing
  4. License
  5. Disclaimer

Features 💫

  • 🚧

Local Development 💻

Here's how you can set up forum in your local dev environment:

Requirements

  • Ruby >= 3.3.1

Ruby is managed using Ruby Version Manager

# Update ruby version
rvm use <version>

Installation

Install the required gems by running the following command:

bundle install

To migrate the database, run the following command:

rails db:migrate
rails db:create db:migrate db:seed

Development

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

To run the specs, a single spec, or a single test:

rails rspec
rspec spec/controllers/user_controller_spec.rb
rspec spec/controllers/user_controller_spec.rb:32 

To start the server, run the following command:

rails server
rails s

To run the rails console, run the following command:

rails console
rails c

Rake Commands

Find missing specs:

rake spec_check:<views | models | controllers | all>    

Makefile Commands

To make life easier, there is a Makefile with some common commands:

To run i18n-tasks normalize and health

make i18n

To format and lint the code

make pretty

Contributing 🤝

License ⚖️

Disclaimer 🚨

This software is currently a work in progress and is considered in ALPHA state. Features will appear and disappear, APIs will be changed, bugs will be introduced, your feedback is always welcome! 🚧🔧