Skip to content

Commit bf85ab5

Browse files
authored
update README.rst
1 parent 46f36a5 commit bf85ab5

File tree

1 file changed

+10
-19
lines changed

1 file changed

+10
-19
lines changed

README.rst

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,19 @@ A Django plugin for creating AJAX driven forms in Bootstrap modal.
99
:local:
1010
:backlinks: none
1111

12-
Live Demo
13-
=========
12+
Test and experiment on your machine
13+
===================================
1414

15-
Demo_
15+
This repository includes ``Dockerfile`` and ``docker-compose.yml`` files so you can easily setup and start to experiment with ``django-bootstrap-modal-forms`` running inside of a container on your local machine. Any changes you make in ``bootstrap_modal_forms``, ``examples`` and ``test`` folders are reflected in the container (see docker-compose.yml) and the data stored in sqlite3 database are persistent even if you remove stopped container.
1616

17-
.. _Demo: http://trco.silkym.com/dbmf/
17+
Note that ``master branch`` contains Bootstrap 4 examples, while ``bootstrap5-examples branch`` contains Bootstrap 5 examples. To experiment with Bootstrap 5 examples simply switch the branch.
1818

19+
Follow the steps below to run the app::
20+
21+
$ clone repository
22+
$ cd django-bootstrap-modal-forms
23+
$ docker compose up (use -d flag to run app in detached mode in the background)
24+
$ visit 0.0.0.0:8000
1925

2026
General information
2127
===================
@@ -28,21 +34,6 @@ Contribute
2834
**********
2935
This is an Open Source project and any contribution is highly appreciated.
3036

31-
32-
Test and experiment on your machine
33-
===================================
34-
35-
This repository includes ``Dockerfile`` and ``docker-compose.yml`` files so you can easily setup and start to experiment with ``django-bootstrap-modal-forms`` running inside of a container on your local machine. Any changes you make in ``bootstrap_modal_forms``, ``examples`` and ``test`` folders are reflected in the container (see docker-compose.yml) and the data stored in sqlite3 database are persistent even if you remove stopped container.
36-
37-
Note that ``master branch`` contains Bootstrap 4 examples, while ``bootstrap5-examples branch`` contains Bootstrap 5 examples. To experiment with Bootstrap 5 examples simply switch the branch.
38-
39-
Follow the steps below to run the app::
40-
41-
$ clone repository
42-
$ cd django-bootstrap-modal-forms
43-
$ docker compose up (use -d flag to run app in detached mode in the background)
44-
$ visit 0.0.0.0:8000
45-
4637
Tests
4738
=====
4839

0 commit comments

Comments
 (0)