forked from AbcSxyZ/bootstrap-studio-to-django-template
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5cdf113
commit dd12465
Showing
1 changed file
with
15 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,76 +1,47 @@ | ||
| # TODO | ||
| # Bootstrap Studio to Django | ||
|
|
||
| Pencil icon changes to a green check mark once export for that file is correct. Else an error symbol. | ||
| Exports a [Bootstrap Studio](https://bootstrapstudio.io/) design into a [Django](https://www.djangoproject.com/) project for an exhilerating low-code web design experience. Allows you to write as much custom/critical code as you would like. | ||
|
|
||
|
|
||
| # bootstrap-studio-to-django-template | ||
| [](https://travis-ci.org/AbcSxyZ/bootstrap-studio-to-django-template) | ||
| [](https://coveralls.io/github/AbcSxyZ/bootstrap-studio-to-django-template?branch=coverall) | ||
|
|
||
| Export a [Bootstrap Studio](https://bootstrapstudio.io/) design into a [Django](https://www.djangoproject.com/) project folder. | ||
|
|
||
| *Credit: Improvement of [lingster/django-bootstrap-studio-tools](https://github.com/lingster/django-bootstrap-studio-tools)* | ||
| *Credit: Improvement of [AbcSxyZ/bootstrap-studio-to-django-template](https://github.com/AbcSxyZ/bootstrap-studio-to-django-template)* | ||
|
|
||
| **Index** | ||
| - [How it works](#how-it-works) | ||
| - [Installation](#installation) | ||
| - [Features](#features) | ||
| - [Contribute](#contribute) | ||
| - [License](#license) | ||
|
|
||
| ## How it works | ||
|
|
||
| This export script will allow you to create custom HTML attributes while developing design with Bootstrap Studio. Those attributes will be convert to their corresponding django template tag inside an export directory. | ||
|
|
||
| Finally, export script will move all html/css/js/img generated by Bootstrap Studio to a `DJANGO_PROJECT`. | ||
| Finally, export script will move all html/css/js/img generated by Bootstrap Studio to a Django project. | ||
|
|
||
| Django is having an application based architecture, **Bootstrap Studio developement must follow this architecture**, create app subfolder and move file inside it. In Boostrap Studio, always create application subfolder inside `Pages`, `Styles`, `JavaScript`, `Fonts` and `Images` folders. (see [tests](test/tree_script/mixed/multiple_assets_type)) | ||
| Django is having an application based architecture, create app subfolder and move file inside it. In Boostrap Studio, always create application subfolder inside `Pages`, `Styles`, `JavaScript`, and `Images` folders. | ||
|
|
||
| If you were to put folders in the root, say Images, then the output will go into DjangoRoot/static/img instead of DjangoRoot/appfolder/static/appfolder/img. I am not sure why we need to output the subfolder of appfolder under appfolder/static. That's just the way Django works by default. | ||
|
|
||
| ## Installation | ||
| The default file placement locations are however, of course, modifiable from the GUI! See this screenshot: | ||
|
|
||
| #### Python | ||
| **WARNING: Require python 3.6 or higher** | ||
|  | ||
|
|
||
| Install project dependencies : | ||
| ``` | ||
| pip install -r requirements.txt | ||
| ``` | ||
| You can use a virtual env inside directory of the export script, and specify folder in `env` file using `VIRTUAL_ENV` (see [env file](#env-file)). | ||
| ## Installation | ||
|
|
||
| #### Bootstrap studio | ||
| Download the .EXE from the releases section of this page. Run the EXE and it will give you instructions on the first tab. These entail essentially, from within BSS: | ||
|
|
||
| Go to `Export Options`. | ||
| - In `Advanced > Export Script`, specify the **absolute path** of `django_export.sh` on your local machine. | ||
|
|
||
| - In `Advanced > Export Script`, specify the **absolute path** of `bss_to_django.exe` on your local machine. | ||
| - Enable options `Use a CDN for libraries`, `Use absolute paths` | ||
| - Specify `Export destination` as well | ||
|
|
||
| `Save` your configuration for later export. | ||
|
|
||
| #### Env file | ||
| Rename `env.template` to `env`. | ||
|
|
||
| Available variables: | ||
| - `DJANGO_PROJECT` **(mandatory)** : Absolute path of your django project folder. | ||
| - `VIRTUAL_ENV` **(optionnal)** : relative path of virtual env directory, **MUST BE** within this script folder. | ||
|
|
||
| #### Test | ||
| To see if everything is running properly : `python -m unittest discover test` | ||
|
|
||
| ## Features | ||
|
|
||
| See all [available features](features.md) | ||
|
|
||
| ## Contribute | ||
| Your help is welcome ! Here some contribution example: | ||
| - [Ask/work for new feature](community_asked_features.md) | ||
| - Add issue/fix for bug | ||
| - Correct spelling/English mistake | ||
| - Improve documentation | ||
| - Code review | ||
| - Test coverage | ||
| - Whatever you have in mind for the software :) | ||
|
|
||
| ## License | ||
|
|
||
| Free software under [AGPL](LICENSE). Please share your modification to respect term of license :) | ||
|
|
||
| --- | ||
| > Written with [StackEdit](https://stackedit.io/). |