Skip to content

Latest commit

 

History

History
153 lines (104 loc) · 2.87 KB

README.md

File metadata and controls

153 lines (104 loc) · 2.87 KB

PreScreen

A Ruby on Rails application for managing screening tests and assessments.

System Requirements

  • Ruby 3.2.0
  • Rails 7.2.2
  • PostgreSQL
  • Redis (for Sidekiq)
  • Node.js & Yarn (for JavaScript bundling)
  • Docker & Docker Compose (optional)

Features

  • User Authentication with Devise
  • Authorization with Pundit
  • Background Job Processing with Sidekiq
  • Modern UI with Tailwind CSS
  • Real-time updates with Hotwire (Turbo & Stimulus)
  • Email handling with Letter Opener (development)
  • Pagination with Kaminari
  • Component-based UI architecture with ViewComponent

Getting Started

Without Docker

  1. Clone the repository
git clone https://github.com/geeekgod/Pre-Screen.git
cd Pre-Screen
  1. Install dependencies
bundle install
yarn install
  1. Setup environment variables
cp .env.example .env
# Edit .env with your configuration
  1. Setup the database
rails db:create
rails db:migrate
  1. Seed the database
rails db:seed

With Docker

  1. Clone the repository and setup environment
git clone https://github.com/geeekgod/Pre-Screen.git
cd Pre-Screen
cp .env.example .env
  1. Build and start the containers
docker-compose up --build
  1. Setup the database
docker-compose exec app rails db:setup

Testing

The application uses Rails' built-in testing framework. To run the tests:

rails test                  # Run all tests
rails test:system          # Run system tests
rails test:models          # Run model tests

Security Testing

bundle exec brakeman      # Run security analysis

Code Style

The project follows Rails Omakase style guide. To check and fix styling:

bundle exec rubocop             # Check code style
bundle exec rubocop -A          # Auto-fix code style issues

Architecture

Models

  • AdminUser: Manages admin authentication and associations
  • Topic: Belongs to AdminUser, has many questions
  • Question: Belongs to Topic
  • Test: Belongs to AdminUser

Background Jobs

Background processing is handled by Sidekiq for:

  • Email delivery
  • Other async tasks (TODO)

Frontend

  • Tailwind CSS for styling
  • Hotwire (Turbo & Stimulus) for dynamic interactions
  • ViewComponent for reusable UI components

Development

Email Testing

  • In development, emails are caught by Letter Opener and displayed in the browser.

  • You can also view them in mail catcher by disabling Letter Opener in development.rb and enable the mail catcher configuration.

Deployment

TODO

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Credits

Built with Ruby on Rails and other open-source software.