|
10 | 10 |
|
11 | 11 | 
|
12 | 12 |
|
| 13 | +## Live Demo |
| 14 | + |
| 15 | +#### https://quill.lhy.kr/ |
| 16 | + |
| 17 | +- Form | https://quill.lhy.kr/posts/create/normal/ |
| 18 | +- ModelForm | https://quill.lhy.kr/posts/create/ |
| 19 | +- Form (Initial HTML) | https://quill.lhy.kr/posts/create/normal/html/ |
| 20 | +- Form (Initial Text) | https://quill.lhy.kr/posts/create/normal/text/ |
| 21 | +- Admin | https://quill.lhy.kr/admin/login/ |
| 22 | + |
13 | 23 |
|
14 | 24 |
|
15 | 25 | ## Documentation
|
@@ -76,12 +86,40 @@ class QuillPostAdmin(admin.ModelAdmin):
|
76 | 86 |
|
77 | 87 |
|
78 | 88 |
|
79 |
| -## docker-compose up (in local) |
| 89 | + |
| 90 | + |
| 91 | +## Running the Live Demo project in local |
| 92 | + |
| 93 | +The live demo is a deployment of the **"playground"** package, which is a django application within this library. |
| 94 | +After cloning or downloading the repository, you can try running the live demo locally. |
| 95 | + |
| 96 | +**A Python virtual environment is required to run the project.** |
80 | 97 |
|
81 | 98 | ```shell
|
82 |
| -docker-compose -f docker-compose-local.yml up --build --force-recreate --remove-orphans |
| 99 | +# [Optional] We recommend that you start after creating a folder for your project. |
| 100 | +mkdir ~/projects |
| 101 | +cd projects |
| 102 | + |
| 103 | +# Clone repository |
| 104 | +git clone git@github.com:LeeHanYeong/django-quill-editor.git |
| 105 | + |
| 106 | +# Go to the project directory and apply the virtual environment |
| 107 | +cd django-quill-editor |
| 108 | +# [apply venv] |
| 109 | + |
| 110 | +# Go to the playground package |
| 111 | +cd playground |
| 112 | + |
| 113 | +# Install requirements |
| 114 | +pip install -r requirements.txt |
| 115 | + |
| 116 | +# Run migrate and runserver |
| 117 | +python manage.py migrate |
| 118 | +python manage.py runserver |
83 | 119 | ```
|
84 | 120 |
|
| 121 | +After the above operation, the live demo site works at localhost:8000. |
| 122 | + |
85 | 123 |
|
86 | 124 |
|
87 | 125 | ## Contributing
|
@@ -129,4 +167,11 @@ cd _build/html
|
129 | 167 | python -m http.server 3001
|
130 | 168 | ```
|
131 | 169 |
|
132 |
| - |
| 170 | + |
| 171 | + |
| 172 | +### docker-compose up (in local) |
| 173 | + |
| 174 | +```shell |
| 175 | +docker-compose -f docker-compose-local.yml up --build --force-recreate --remove-orphans |
| 176 | +``` |
| 177 | + |
0 commit comments