Skip to content

little-bobby-tables/fanuniverse

Repository files navigation

Fan Universe

A repository for Fan Universe application code.

Contributing

Follow this instructions to get the application up and running on your local machine for development and testing.

Prerequisites

Install the following dependencies (packages in parentheses are specified for RPM-based distributions):

  • Java 8+ (java-1.8.0-openjdk)
  • Elasticsearch 5
  • PostgreSQL 9.6 with pg_similarity extension
  • Redis (redis)
  • ImageMagick (ImageMagick)
  • libpng and libjpeg development headers (libpng-devel, libjpeg-devel)
  • FFmpeg (ffmpeg with RPM Fusion)
  • Node.js (nodejs)
  • Yarn

You'll also need a Ruby version manager (such as chruby) with Ruby 2.4.1 installed.

Running the application

bin/setup prepares the environment (installs gem dependencies and creates the database). You only need to run this once.

bin/gulp tracks changes to JS and CSS files and automatically recompiles the assets.

puma boots the application server on port 3000.

sidekiq processes background jobs.

rails test runs the test suite.