Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for structured scaffolding in create command, retaining current templates #969

Open
ashupednekar opened this issue Sep 25, 2024 · 1 comment · May be fixed by #970
Open

Support for structured scaffolding in create command, retaining current templates #969

ashupednekar opened this issue Sep 25, 2024 · 1 comment · May be fixed by #970
Labels
enhancement New feature or request

Comments

@ashupednekar
Copy link

Feature Request: Add Structured Scaffold Option to Robyn's Create Command

Description:

The current create command in Robyn initializes API projects with a basic structure but lacks flexibility for more complex use cases. To address this, a new option should be introduced that allows developers to choose between:

  • A simple starter kit.
  • An opinionated structured scaffold for more robust project setups.

Requirements:

  • Add a prompt during project initialization to choose between a simple or structured scaffold.
  • Extend the current simple starter structure (with database options like Mongo, Postgres, etc.).
  • Include a new structured approach that introduces separation of concerns, such as:
    • api/handlers
    • middlewares
    • adapters/models
    • utils
    • devops (with Docker and docker-compose configurations)

Acceptance Criteria:

  • Ensure that both simple and structured scaffolds can be generated correctly.
  • Document the scaffold options in the README.

Example Structure:

For the structured scaffold, each database option should include additional layers for better maintainability. For example:

  • sqlalchemy scaffold should include:
    • adaptors (for models, mutators, selectors)
    • api/handlers (for API routes)
    • devops (for Docker, docker-compose)
    • utils/db.py
@ashupednekar ashupednekar added the enhancement New feature or request label Sep 25, 2024
@ashupednekar ashupednekar linked a pull request Sep 25, 2024 that will close this issue
3 tasks
@sansyrox
Copy link
Member

Love the initiative @ashupednekar . Thank you 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants