Feat: Stencil CLI

[prtkjakhar]

New CLI Tool Proposal: Template-Based Project Generator

Overview

This proposal outlines the development of a new CLI tool designed to streamline and simplify the process of initializing projects by providing a selection of predefined templates and configurations. Similar to the NextJS CLI, this tool will offer users a guided experience through a series of choices that culminate in the generation of a fully configured project.

Templates and Configurations

General Templates

1. React Template

   • [ ] Basic React setup using preferred configurations.

2. Next.js Template https://github.com/SamagraX-Stencil/ui-templates/issues/48

   • [ ] Basic Next.js setup including essential Next.js features like API routes.

Feature-Specific Functionality

• [ ] Context API: For state management across components.
• [ ] Translation: Internationalization and localization support.
• [ ] Routing: Client-side routing.
• [ ] Redux: State management with Redux.
• [ ] Flagsmith: Feature flagging for controlled rollouts.
• [ ] Firebase: Integration with Firebase for backend operations.

Standard Pages

• [ ] Login
• [ ] Register
• [ ] OTP Verification
• [ ] User Dashboard
• [ ] User Profile Management
• [ ] Chat Interface
• [ ] Activity History
• [ ] Frequently Asked Questions (FAQ)
• [ ] Service Downtime Page
• [ ] Coming Soon Page
• [ ] Generic Form
• [ ] Feedback Collection

3. Admin Template

Functionality

• [ ] No RBAC (Role-Based Access Control) with various data providers:
  • [ ] Simple REST Provider
  • [ ] Custom Data Provider
  • [ ] Hasura Data Provider
• [ ] RBAC with the above data providers
• [ ] Custom Theming: Ability to apply custom themes.

Admin Pages

• [ ] Login Page
• [ ] Main Dashboard
• [ ] List View
• [ ] Edit Record
• [ ] Create Record
• [ ] Detailed View

Testing Checklist

• [ ] Cross-Browser Testing: Ensure compatibility across Chrome, Firefox, Safari, and Edge.
• [ ] Mobile Responsiveness: Test responsiveness on various devices and screen sizes.
• [ ] Accessibility Testing: Check accessibility issues using tools like axe or Lighthouse.
• [ ] Performance Testing: Aim for high performance scores (above 90) on Lighthouse audits.

Documentation Requirements

• [ ] Getting Started Guide: Detailed instructions on initializing and configuring projects using the CLI.
• [ ] Customization Guidelines: Tips for tailoring the template to specific needs.

Acceptance Criteria

• [ ] Each functionality integrates seamlessly without conflicts.
• [ ] Comprehensive, easy-to-understand documentation.
• [ ] Dynamic UI that adjusts based on selected template options.
• [ ] All functionalities are fully tested and pass established tests.
• [ ] Compatibility with major operating systems (macOS, Linux, Windows).
• [ ] Optimized performance across all conditions.

Submission Guidelines

Please ensure that your contributions adhere to the outlined specifications and submit a pull request for review by the project maintainers.