Skip to content

Latest commit

 

History

History
88 lines (69 loc) · 5.88 KB

CONTRIBUTING.md

File metadata and controls

88 lines (69 loc) · 5.88 KB
Raw

Contributing

Getting set up

Prerequisites

  • Ruby 3.3
  • Postgres 14.x
  • Node.js 16.x
  • Yarn 1.x
  • ImageMagick (for images, like avatars or game covers)

Setup instructions

  1. Clone the repository with git
  2. To get Bundler 2.5.9, gem install bundler:2.5.9
  3. bundle install
  4. yarn install
  5. bundle exec rails db:setup
    • This is the equivalent of running bundle exec rails db:create && bundle exec rails db:structure:load && bundle exec rails db:seed, so it will create the databases, seed them with fake data, and create a user with the email admin@example.com and the password password.
    • If you would like more control, run only bundle exec rails db:create and bundle exec rails db:schema:load.
    • If you run into an error about the database password being wrong, the application will try to use 'password' by default, but you can set the password for your database user via the VGLIST_DATABASE_PASSWORD environment variable.
  6. bundle exec rails server to start the server.
  7. Visit http://localhost:3000 in your browser and you should see the base application.
  8. In a separate terminal window, run bin/webpack-dev-server alongside the Rails server to have a webpack-dev-server instance.
    • You don't have to do this for the site to work, but things will take a lot longer to load as Webpack has to compile stuff from within the same process as Rails.

Extras

Optional environment variables for miscellaneous functionality:

  • STEAM_WEB_API_KEY: If you want to use the Steam import functionality, you'll need to generate a Steam Web API Key.
  • MOBYGAMES_API_KEY: If you want to use the MobyGames cover import Rake task, you'll need to get a MobyGames API key.
  • TWITCH_CLIENT_ID, TWITCH_CLIENT_SECRET: If you want to use the IGDB cover import Rake task, you'll need to create an OAuth app for the Twitch API.
    • The "OAuth Redirect URL" for the OAuth app can just be set to http://localhost, the redirect URL isn't used.

Libraries

This is a list of libraries used for various functionality across the app. It's not guaranteed to be comprehensive or up-to-date, but I'll try my best to keep it updated.

  • Ruby on Rails: Web application framework.
    • ActiveRecord: Used for SQL queries, migrations, and maintaining the database structure.
    • ActiveStorage: Used for image storage.
    • Webpacker: JavaScript / SCSS bundler, essentially Webpack with Rails integration.
  • Sorbet: Gradual static typing for Ruby.
  • Postgres: Database engine that the application uses.
  • PgSearch: Powers search for games, companies, series', etc.
  • Devise: Authentication framework, for logging in and other user authentication things.
  • Pundit: Authorization framework, used for making sure users are actually authorized to perform a given action in the application.
  • Doorkeeper: OAuth authentication handler, for creating tokens used by the API.
  • RSpec: Ruby testing framework used for unit tests, request specs, feature specs, model specs, etc.
  • FactoryBot: Factories for seeding the database and writing tests.
  • GraphQL via graphql-ruby: GraphQL is a query language that is used for the vglist API.
  • TypeScript: Dialect of JavaScript with static types, most of the JavaScript in the application is written in TypeScript.
  • Vue.js: JavaScript framework for dynamic webpages, used for various complex pages and elements, e.g. the search bar, library table, etc.
  • Font Awesome: Icons used in the application mostly come from Font Awesome.
  • Bulma: CSS Framework used for styling the application.

Rake tasks

Rake tasks are Ruby code for performing tasks. For vglist, most of these are for importing data.

  • Importing
    • rake import:update - Imports updated data for existing games, companies, genres, series, etc.
    • rake import:wikidata:games - Imports new games.
    • rake import:full - Imports new games, companies, genres, series, etc.
    • rake import:pcgamingwiki:covers - Imports covers from PCGamingWiki.
    • rake import:mobygames:covers - Imports covers from MobyGames, needs a MobyGames API key.
    • rake import:igdb:covers - Imports covers from Internet Game Database (IGDB), needs a Twitch API key.
    • rake pg_search:multisearch:rebuild:all - Rebuild the search indices, useful after running imports.
  • Deployment
    • rake deploy:production - Deploys the website in production mode, for use on the production server.
  • Development
    • rake sorbet:update:all - Updates all the Sorbet type signatures based on current code.
    • rake db:seed - Creates fake data, mostly for development.

GitLab CI

To update the Docker container used by GitLab CI:

  • Log into the GitLab CI Docker registry with docker login registry.gitlab.com (you'll need to use a Personal Access Token as your password).
  • Build the container with docker build --platform=linux/amd64 -f Dockerfile -t registry.gitlab.com/vglist/vglist .
    • You may want to add --no-cache to fully rebuild the container from scratch.
  • Then use docker push registry.gitlab.com/vglist/vglist to push the container to the GitLab Container Registry.

Design Document

See DESIGN_DOC.md for the general design plan for this project.