Skip to content

Project Structure

Shreyash Saitwal edited this page Mar 14, 2021 · 4 revisions
<extension-name>
  ┣━ .rush 
  ┣━ assets  1️⃣  
  ┣━ deps    2️⃣ 
  ┣━ src
  ┃    ┣━ <domain>
  ┃    ┃   ┗━ <company>
  ┃    ┃       ┗━ <extensionname>
  ┃    ┃           ┗━ <ExtensionName>.java  3️⃣ 
  ┃    ┣━ AndroidManifest.xml  4️⃣ 
  ┃    ┗━ proguard-rules.pro   5️⃣ 
  ┣━ .gitignore
  ┣━ README.md
  ┗━ rush.yml  6️⃣ 
  1. assets directory
    • This is the place where you store all your extension's assets, including the icon.
  2. deps directory
    • This is the place where you store your extension's dependencies (JAR, AAR).
  3. <Extension>.java
    • This is your extension's source file. Currently, only Java is supported but Kotlin is planned as well.
  4. AndroidManifest.xml
    • All the Android manifest tags required by your extension are defined here.
    • Check out this wiki to know more about AndroidManifest.xml in Rush.
  5. proguard-rules.pro
    • This is where you define the ProGuard rules for your extension.
    • For more info about ProGuard rules, check out the usage manual.
  6. rush.yml
    • This file is responsible for holding metadata about your extension, and hence, is also known as the metadata file.
    • Check out this wiki to know more about rush.yml and the supported fields.
Clone this wiki locally