README.md

1. Environment

• Ruby 4.0.2

2. Install Gems via Gemfile and Bundler

$ bundle install
$ bundle lock --add-checksums

3. Execution

$ ruby main.rb 
Provide your username(Default: hayat01sh1da)
hayat01sh1da
Provide your preferred unit d(daily - default), w(weekly) or m
d
Provide the specific year you would like to create working report templates for(Default: the current year)
2024

4. Unit Test

$ rake
Run options: --seed 39473

# Running:

........

Finished in 11.855362s, 0.6748 runs/s, 1.0966 assertions/s.

8 runs, 13 assertions, 0 failures, 0 errors, 0 skips

5. Static Code Analysis

$ rubocop
Inspecting 5 files
.....

5 files inspected, no offenses detected

6. Type Checks

$ rbs-inline --output sig/generated/ .
🎉 Generated 3 RBS files under sig/generated
$ steep check
# Type checking files:

......

No type error detected. 🫖