Custom Repository¶

Overview¶

The Custom Repository is a specialized GitHub repository provided to Pro and Enterprise customers for managing custom components and app modifications. This repository serves as a structured storage space for your custom components, allowing seamless integration with your mobile app.

Getting Access¶

1. Upon signing up for a Pro or Enterprise plan, you'll receive:
2. A GitHub repository invitation within 24 hours
3. Access credentials and setup instructions
4. Documentation for component development

Repository Structure¶

The repository comes pre-configured with organized folders for different app sections:

custom-repository/
├── shop/
├── cart/
├── account/
├── wishlist/
├── product-details/
├── product-list/
└── app-blocks/

Each folder contains: - Component templates - Style guidelines - Integration instructions - Example implementations

How It Works¶

1. Access Repository
2. Accept the GitHub invitation
3. Clone the repository locally

4. Review the provided documentation

5. Develop Components

6. Navigate to the appropriate folder
7. Follow the component building guidelines
8. Test your changes locally

9. Commit and push your changes

10. Publish Changes

11. Log into your Shopify app
12. Navigate to the App Settings
13. Click the "Publish" button
14. Wait for changes to propagate

Deployment Timeline¶

Best Practices¶

1. Organization
2. Keep components in their designated folders
3. Follow the provided naming conventions

4. Document any custom implementations

5. Testing

6. Test components thoroughly before publishing
7. Verify functionality across different devices

8. Check for any conflicts with existing components

9. Version Control

10. Make meaningful commit messages
11. Create branches for major changes
12. Keep your local repository updated

Common Use Cases¶

• Custom shopping cart experiences
• Specialized product detail pages
• Unique account management interfaces
• Custom wishlist functionality
• Branded app blocks and components

Limitations¶

• Repository is for component storage only
• Direct app modifications are not possible
• All changes must be published through the Shopify app
• Some components may require review before deployment

Support¶

Need help with your custom repository? - Review the repository's README file - Check the provided example components - Contact our support team at admin@appora.ca

Security¶

• Repository access is strictly controlled
• All code is reviewed during the merge process
• Sensitive information should never be committed
• Follow security best practices provided in the documentation

Next Steps¶

1. Wait for your GitHub invitation (within 24 hours of plan upgrade)
2. Set up your local development environment
3. Review the repository documentation
4. Start building your custom components