Skip to content

Latest commit

 

History

History
77 lines (48 loc) · 3.36 KB

LOCAL.md

File metadata and controls

77 lines (48 loc) · 3.36 KB
Raw

Running Locally (Not Recommended, Accuracy of documentation suspect)

Follow these steps to setup the App for creators.brave.com. This guide presumes you are using OSX and Homebrew.

  1. Install Ruby. For a Ruby version manager try rbenv. Follow the Installation section instructions and ensure your version is at least 1.1.2. Once installed run rbenv install. Be sure to restart your terminal before continuing.

  2. Install Node 6.12.3 or greater: brew install node

  3. Install Postgresql 9.5+: brew install postgresql

    If you get the error psql: FATAL: role “postgres” does not exist. You'll need to create the /usr/local/opt/postgres/bin/createuser -s postgres

  4. Install Redis: brew install redis

  5. Install Ruby gems: gem install bundler foreman mailcatcher.

  6. Install Yarn for Node dependency management: brew install yarn

  7. Install project dependencies

    Ruby dependencies: bundle install

    Possible errors:

    • Nokogiri, with libxml2. Try installing a system libxml2 with brew install libxml2 and then bundle config build.nokogiri --use-system-libraries then again bundle install
    • Run gem install nokogiri -v '1.10.3' and then bundle install

    Node dependencies: yarn --frozen-lockfile

    Your version of Node must be v11.15.0 or earlier. For a node version manager, try NVM.

  8. Install git-secrets with brew install git-secrets This prevents AWS keys from being committed.

  9. (Optional) Get a .env file from another developer which contains development-mode env vars. You can start developing without this, but some functionality may be limited.

  10. Install Rails: gem install rails

    Be sure to restart your terminal before continuing.

  11. Configure SSL certs make certs

Run

  1. Start Postgres and Redis: brew services start redis postgresql

  2. Create and initialize the database:

    rails db:create RAILS_ENV=development
rails db:migrate RAILS_ENV=development

    Note: If you receive a fatal-role error, try running /usr/local/opt/postgres/bin/createuser -s postgres due to being installed from homebrew. Further documentation is here.

    If you receive an error about Readline, try running:

    ln -s /usr/local/opt/readline/lib/libreadline.dylib /usr/local/opt/readline/lib/libreadline.7.dylib

    Issue for further documentation.

  3. Run Rails server and async worker: bundle exec puma -C config/puma.rb -e ${RACK_ENV:-development} bundle exec sidekiq -C config/sidekiq.yml -e ${RACK_ENV:-development}

  4. Visit https://localhost:3000

  5. To test email, run a local mail server with: mailcatcher

  6. To view the emails sent to your inbox visit: http://localhost:1080

  7. Run webpack separately: ./bin/webpack-dev-server

  8. Compile landing page assets: cd public/landing-page; rake assets:clobber; rake assets:precompile; yarn install; yarn build