https://github.com/timonweb/django-bulma

Bulma theme for Django
https://github.com/timonweb/django-bulma

bulma bulma-theme css django django-bulma

Last synced: about 2 months ago
JSON representation

Bulma theme for Django

• Host: GitHub
• URL: https://github.com/timonweb/django-bulma
• Owner: timonweb
• License: mit
• Created: 2017-08-16T16:10:14.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T04:33:09.000Z (over 1 year ago)
• Last Synced: 2024-04-03T19:43:22.073Z (6 months ago)
• Topics: bulma, bulma-theme, css, django, django-bulma
• Language: CSS
• Homepage:
• Size: 1.34 MB
• Stars: 334
• Watchers: 14
• Forks: 54
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# A Bulma Theme for Django Projects

![Django Bulma](https://raw.githubusercontent.com/timonweb/django-bulma/master/assets/django-bulma-logo.png)

A Django base theme based on Bulma ([bulma.io](https://bulma.io/)). Bulma is a modern CSS framework based on Flexbox.

*** work in progress ***

## Installation

1. Install the python package django-bulma from pip

  ``pip install django-bulma``

  Alternatively, you can install download or clone this repo and call ``pip install -e .``.

2. Add to INSTALLED_APPS in your **settings.py**:

  `'bulma',`

3. If you want to use the provided base template, extend from **bulma/base.html**:

  ```

  {% extends 'bulma/base.html' %}

  {% block title %}Bulma Site{% endblock %}

  {% block content %}

    Content goes here...

  {% endblock content %}

  ```

  

4. If you want to customize bulma sass and your own components:

    4.1 Copy bulma static files into your project's **STATIC_ROOT**:

    ```

    python manage.py copy_bulma_static_into_project

    ```  

    You should see **bulma** dir appeared in your **STATIC_ROOT**. It contains

    two dirs:

    * **sass** - this is the place where you can put your own sass code and customize

    bulma variables

    * **css** - this is where compiled sass output goes, you should link this file

    in your base.html 

    4.2 Install npm packages for sass compilation to work:    

    

    ```

    python manage.py bulma install

    ```

    

    4.3 Start sass watch mode:

    ```

    python manage.py bulma start

    ```

5. For forms, in your templates, load the `bulma_tags` library and use the `|bulma` filters:

    ##### Example template

    

    ```django

    {% load bulma_tags %}

    {# Display a form #}

    

       {% csrf_token %}

       {{ form|bulma }}

       


         Login

       

       

    

    ```


## Included templates

**django-bulma** comes with:

* a base template,

* django core registration templates,

## Bugs and suggestions

If you have found a bug or if you have a request for additional functionality, please use the issue tracker on GitHub.

[https://github.com/timonweb/django-bulma/issues](https://github.com/timonweb/django-bulma/issues)