Video walkthrough of the codebase

[andymeneely]

We need an hour-ish long walkthrough of the codebase for new folks. Timecode the whole thing and put it on youtube for future generations.

These are things we need to cover:

• [ ] Data repos
• [ ] Example curation file
• [ ] Example pull request for a curation
• [ ] Heroku dashboard on a build, building to alpha
• [ ] rails data:all
  • [ ] lib/tasks/
  • [ ] lib/data_builder.rb
  • [ ] Loaders
  • [ ] lib/loaders/project_loader.rb
  • [ ] Taggers
  • [ ] lib/taggers/project_tagger.rb
  • [ ] Event Generators
  • [ ] lib/event_generators/fix_events.rb
  • [ ] lib/event_generators/weekly_report_generator.rb
• [ ] Web App
  • [ ] /vulnerabilties page example
  • [ ] routes.rb
  • [ ] /app/controllers/application_controller.rb
  • [ ] /app/contollers/vulnerabilities_controller.rb
  • [ ] /app/views/index.html.erb
  • [ ] Webpack overview
  • [ ] config/webpack/webpack.config.js
  • [ ] Rails Asset Pipeline
  • [ ] app/assets/javascripts/routes.js
  • [ ] app/assets/javascripts/vulnerabilities/index.js
  • [ ] app/assets/javascripts/vulnerabilities/vulnTable.js (jQuery datatables)
  • [ ] app/assets/global/vhpMarkdown.js
  • [ ] app/assets/stylesheets/vhp.scss
  • [ ] SCSS in general
  • [ ] Foundation, app/assets/stylesheets/foundation_config.scss
  • [ ] Foundation XY Grid
  • [ ] app/assets/stylesheets/icons.scss
  • [ ] app/models/event.rb
  • [ ] app/models/vulnerability.rb
  • [ ] schema.rb
  • [ ] rails console, and ActiveRecord
• [ ] Tests
  • [ ] rails test
  • [ ] Unit tests
  • [ ] System tests

Check the following:

• [x] I have checked the VHP backlog for something similar: https://github.com/VulnerabilityHistoryProject/vulnerability-history/issues

[andymeneely]

Should make these into smaller ~10 minute videos. Maybe break it down like this:

• Example curation file and build process, database schema
• Lifecycle of Rails
• Front end structure: foundation xy grid, webpack, scss, icons,
• D3 visuals
• Dev infrastructure: tests, ghactions, heroku