Enumeratorr

A Ruby on Rails application using Rails 7.1.5, Ruby 3.3.0, and PostgreSQL.

Prerequisites

Ensure you have the following installed:

• Mise - A modern runtime version manager. Install it from mise website.

• Ruby 3.3.0 - Check with:

  ruby -v

  Install using:

  mise use [email protected]

• Rails 7.1.5 - Check with:

  rails -v

  Install using:

  gem install rails -v 7.1.5

• PostgreSQL - Check with:

  psql --version

  Install from the PostgreSQL website.

• Levenshtein Extension for PostgreSQL - Used for fuzzy string matching. Install it by running:

  CREATE EXTENSION IF NOT EXISTS fuzzystrmatch;

Installation

1. Clone the repository:

   git clone https://github.com/gitChang/enumeratorr.git
   cd enumeratorr

2. Install dependencies:

   bundle install

3. Configure the database: Edit config/database.yml:

   default: &default
     adapter: postgresql
     encoding: unicode
     username: your_postgres_username
     password: your_postgres_password
     host: localhost
   
   development:
     <<: *default
     database: enumeratorr_development
   
   test:
     <<: *default
     database: enumeratorr_test

4. Create the database:

   rails db:create
   rails db:migrate

Running the Application

Start the Rails server:

rails server -p 3003

The app will be available at http://localhost:3003.

Using Docker (Optional)

1. Build the Docker image:

   docker build -t enumeratorr .

2. Create a Docker volume:

   docker volume create enumeratorr-storage

3. Run the container:

   docker run --rm -it -v enumeratorr-storage:/rails/storage -p 3003:3003 --env RAILS_MASTER_KEY=<your-master-key> enumeratorr

Replace <your-master-key> with your Rails master key.

Generating Secret Key Base

rails secret

Set this key in your environment variables or credentials file as needed.

---

For more information, refer to the Rails Guides, Mise Documentation, and PostgreSQL Documentation.