Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 2.57 KB

README.md

File metadata and controls

51 lines (33 loc) · 2.57 KB
Raw

Remotely Playable Tetris

How to dev?

  1. Clone the repo
  2. Set the Environment variables based on .env.example
  3. Run yarn
  4. Run yarn dev
  5. Open the controller and display in your browser at http://localhost:3000 and http://localhost:3000/display
  6. ????
  7. Create a PR
  8. Profit

How to deploy?

When a PR is merged to master it's automatically deployed to https://reaktor-tetris-staging.herokuapp.com/. Master is deployed manually via Heroku to https://reaktor-retris-production.herokuapp.com/. To access the apps you'll need access. Joonas (@aki7) can help you with this.

Bug tracking

Clientside bugtracking uses a free version of Bugsnag. Currently Joonas and Ákos has access to the collected data. Ask them to get access.

Good to know

When you're running yarn pretty and you save a file in your editor it's automatically formatted with prettier to match the lint rules. Imports aren't organised automatically by yarn pretty. That you'll need to do on your own.

Add custom translations

Currently Google Spreadsheet based custom translation is offered.

How to add custom translations

  1. Open src/i18n/default-translation.ts
  2. Fill an empty Google Spreadsheet's first column with the default translation keys
  3. Add your translations to the second column
  4. Make your Sheet publicly available (readable)
  5. Go to https://console.cloud.google.com/apis/library/sheets.googleapis.com and generate an API key
  6. When starting the application provide the following environment variables (you can use .env too):
  1. If the environment variables are provided, the app will try to download and merge the Spreadsheet translations into the defaults on each page load.

Check out the following sheet for an example structure: https://docs.google.com/spreadsheets/d/1KNi3vxCagcMp0x7dFKfo_CnIkWMaCwHadRPwuz23xm8/edit#gid=0

Frontend environment variables

Some config env vars are used by the frontend, like Google Analytics tracking ID. This is separated into a client-config.ts file, as we want to avoid exposing sensitive configurations.

If you'd like to add additional env config that is visible to the client, you'll also have to include the variable in the next.config.js file's new webpack.EnvironmentPlugin object, so that it is injected into the frontend code during build time.