Step 4 - Configuration
This is where the magic happens!
Welcome to the last step of FlyCode's configuration flow! In this crucial step we'll define key information about your project which will make sure we do our best to help you! The page you should see is this:
FlyCode configuration page
You'll see some of the fields are already filled out - thanks to the code scan from the previous step, we determined some probable choices you might make and filled them out for you to save you some hassle. Of course, if you'd like you can change those to whatever you wish.
Let's go over the fields together:
  • Select branch: Here you can select the branch to which you'd like to connect FlyCode, and to which the text changes you'll make through FlyCode will apply.
  • App name: This will be the name of the FlyCode Application you're configuring. It'll be displayed in your dashboard, so pick a name you'll know to associate with this configured application. We auto filled this field to be the name of the repository you're connecting.
  • Base directory: This is the base directory of your project, AKA where your package.json is. If we found any packages, their paths will be displayed in the drop-down menu when you click on this field. You can leave it empty to set it as your root directory (/), or input your own path, even if we didn't detect it. Why do we need this information? Let's say, for example, you have a single repository for both the backend and the frontend of your project, but the texts you'd interact with are (most likely) in the frontend. So, in order for us to narrow down where to look for them, you'd want your base directory to be frontend/ (assuming frontend is the name of your frontend directory).
  • Text resources format: This is the format of your text resources. They might be in a JSON, PO, or hardcoded in React, Angular or Vue. Choose the option that's most relevant to you. Currently we support only one option per FlyCode Application, so if you have, for example, texts hardcoded in React and some more in a JSON - you can either choose the option most relevant to you, or contact us and we'll figure it out together.
  • [OPTIONAL] Text resources path: This option will pop up under Text resources format if the format you chose isn't hardcoded (JSON or PO). If found, this field will display the generalized paths of the text resources as options in the drop-down menu of this field, with numbers next to each option which represent the number of resources found in each path, but you can enter a new path if you wish. Important note - this path is relative to the Base directory's path which you've input earlier. So, if your Base directory is frontend/, and your text resources are under frontend/src/langs/*.json, what you'd want to enter in this field is src/langs/*.json.
The Text resource path is relative to the base directory
This form, once complete, will generate a .flycode.yaml file for your repository, that'll let us know where to look for your text resources. As suggested at the bottom of the page, you can also add a .flycode.yaml manually, or tweak it later as needed. A documentation regarding this file and its options can be found in this section of our docs.
Copy link