README

This README would normally document whatever steps are necessary to get the application up and running.

Things you may want to cover:

• Ruby version - 3.2.2

• System dependencies - Docker, Postgres

• Configuration - none

• Database creation - rails db:create

• How to run the test suite

• Services (job queues, cache servers, search engines, etc.)

• Deployment instructions

• ...

Setup

1. To run the application in development build an image:

$ docker-compose build

2. Setup test and development databases:

$ docker-compose run app bundle exec rails db:setup

3. To start rails application server execute (port 3000):

$ docker-compose up

4. Create elastic import

$ docker-compose run app rake elastic:setupdb

Run tests

It's required to up elastic before running test, as it took time

$ docker-compose up elasticsearch

After it's up

$ docker-compose run app bundle exec rspec

Import dataset

$ docker-compose run app rake dataset:import

TODO

• Change versions of gems, ruby
• Add todo list to README
• Add rspec
• Add rubocop, rubocop-rails, rubocop-rspec rubocop-performance
• Update bundler
• Add docker, docker-compose add readme to how to run
• Add controller (rswag/request test) for success index
• Add controller, route, action index, view
• Add comment about authorization
• Add simplecov
• Create Prompt model
• Add database set import
• Add database_cleaner-active_record
• Add elasticsearch
• Add search feature into model
• Search for 4 k => 4k
• Add showing all Prompts
• Add UI for search
• Add deployment configs
• Improve routes for main page
• Add 3 d => 3d analyzer
• Terms like "8k," "4k UHD," "highly detailed have same meaning

TODO good to have

• Add validation for empty text in prompt
• Add 20 17 => 2017 analyzer
• Add Igor's => Igor
• Add logic for emojis
• Create searchable index for artists
• Tagging female angel, handsome samurai"
• Add score to the view
• Improve readme.
• Add error handling message
• Clean Rails (requires, unused files)
• Add breakeman, bundle-audit
• ./lib/tasks/import_dataset.rake
  • Add logic for unsuccess request
  • Possible improvement collect all data and import it once in batches.
• ./spec/support/stubs/dataset_stub.rb
  • Move url to credentials
• ./spec/rake/import_dataset_spec.rb
  • make stub dynamic by offset and length
• Add proper healthcheck for elastic
• Have different elastic db for different envs
• Add Pagination
• Fix Prompt.import