Management Commands¶

To smooth your development flow, please get familiar with these commands to help ensure your nxtbn development success:

  1. python manage.py nxtbn_init

    • This command initializes the nxtbn environment by generating some predefined categories and collections. It internally calls python manage.py populate_predefined_category and python manage.py populate_predefined_collection.

  2. python manage.py populate_predefined_category

    • Generates categories that are defined in a JSON file. This helps in setting up the initial category structure for your e-commerce site.

  3. python manage.py populate_predefined_collection

    • Generates collections that are hard-coded into the system. These collections can be used to group products in various ways for display on the site.

  4. python3 manage.py generate_nxtbn_api_docs

    • Generates OpenAPI documentation in YAML format. This is useful for developers who need to understand and interact with the nxtbn API.

  5. python manage.py fake_populate_product

    • Generates fake product data. This is useful for testing and development purposes when real product data is not yet available.

  6. python manage.py fake_populate_order

    • Generates fake order data. This helps in testing order processing and management workflows without using real customer data.

  7. python manage.py populate_fake_users

    • Generates fake user accounts. You can specify the number of fake users you want to generate by passing an argument to the command. This is useful for testing user-related features.

  8. python manage.py install_plugin_via_zip_url

    • Install plugin via zip url: example command: python manage.py install_plugin_via_zip_url https://github.com/nxtbn-com//archive/refs/tags/1.0.0.zip

  9. python manage.py register_plugin to register a plugin, argument is directory name

  10. python manage.py toggle_plugin_status deactivate <YOUR_PLUGIN_NAME> to activate/dectivate plugin

For other commands based on Django, please check this documentation: Django management Commands. These are not related to nxtbn but are good for handling things smartly.