Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.45 KB
Raw

Contributor Guidelines (kinda)

While this is shockingly still running in production, the plan is to migrate off this frontend to a new one rewritten from scratch to be more maintainable, hosted as static files and running on top of the newer REST API.

👋 Help wanted! Front-end devs (especially if you have experience in high performance React/Redux etc) if you are interested in helping out, please get in touch! 👻

Development Setup

Frontend + REST API

  1. Make sure you have Ruby 2.2.x installed and gem install bundler.

  2. Get the repository and basic dependencies going:

    git clone mroth/emojitrack
cd emojitrack
bundle install --without=production

  3. Copy .env-sample to .env and configure required variables.

  4. Make sure you have Redis installed and running. The rules in lib/config.rb currently dictate the order a redis server instance is looked for. Depending on what you are doing, you may need to have the db populated from a emojitrack-feeder instance.

  5. Run all processes via foreman start.

Frontend development only

You can do work on the web frontend only by utilizing the production REST API. Set FRONTEND_ONLY=true in your .env file, and the API routes will not be loaded and the AJAX calls will be routed to the production API instead of localhost.