Boilerplate Manager

Boilerplate Manager

About

Boilerplate Manager is a Django app to generate forms, templates, API, views for apps of your project. For each app in your project, you create the models and after you can generate all the forms, templates, APIs and views of this app, you will only need to take care of the business rule.

Detailed documentation is in the “docs” directory.

Overview

boilerplate-manager is a well tested, documented, and base management app to generate forms, templates, API, views for apps of your project.

Supported Django and Python versions

Django \ Python	3.5	3.6
2.1	*	*

Documentation

Installation

To install boilerplate-manager:

    $ pip install boilerplate-manager

Add core to your INSTALLED_APPS setting:

    INSTALLED_APPS = [
        # other apps
        "core",
    ]

Add core.urls to your project urlpatterns:

from django.urls import include,path

    urlpatterns = [
        # other urls
        path('core/', include('core.urls'), name='core'),
    ]

Run

    $ python manage.py migrate

to create the core models.

Run

    $ python manage.py runserver

to run the server

Visit http://127.0.0.1:8000/core/ to list the apps installed in your project.

Usage

To generate the files of your model, create one app and write your models. The models should extends Base.

Example:

#others imports
from core.models import Base

#Create your models here.
class NameModel(Base):
   ...

After this, run the command to generate the files of the app.

   $ python manage.py build <your_app_name>

This command will generate all the forms, views, Api Rest and templates for your app based in your models.

To generate the files only one specific model, run this command:

   $ python manage.py build <your_app_name> <your_model_name>

This command will generate all the forms, views, Api Rest and templates for your model.

After this procedure add your app in the main urls of your project:

    urlpatterns = [
        # other urls
        path('core/<your_app>', include('<your_app>.urls'), name='<your_app>'),
    ]

Run

    $ python manage.py migrate

to create the core models.

Run

    $ python manage.py runserver

to run the server

Visit http://127.0.0.1:8000/core/ to list the apps installed in your project.

Built With

Django - The high-level Python Web framework that encourages rapid development and clean, pragmatic design.
Bootstrap 4 - The open source toolkit for developing with HTML, CSS, and JS.

Change Log

v1.0.0

🎉 first release!

Contributing

Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests to us.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

newtongaliza / boilerplate-manager Goto Github PK