Skip to content

Commit 26049ff

Browse files
committed
Update README.md, login/logout redirect change
1 parent b90df15 commit 26049ff

File tree

3 files changed

+53
-3
lines changed

3 files changed

+53
-3
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
/.media
22
/.static
3+
/playground/.static
4+
/playground/.media
35

46
# Created by https://www.gitignore.io/api/git,node,linux,macos,django,python,windows,pycharm+all,webstorm+all,visualstudiocode
57
# Edit at https://www.gitignore.io/?templates=git,node,linux,macos,django,python,windows,pycharm+all,webstorm+all,visualstudiocode

README.md

+48-3
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,16 @@
1010

1111
![django-quill-editor](https://raw.githubusercontent.com/LeeHanYeong/django-quill-editor/master/_assets/django-quill-editor-sample.png)
1212

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+
1323

1424

1525
## Documentation
@@ -76,12 +86,40 @@ class QuillPostAdmin(admin.ModelAdmin):
7686

7787

7888

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.**
8097

8198
```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
83119
```
84120

121+
After the above operation, the live demo site works at localhost:8000.
122+
85123

86124

87125
## Contributing
@@ -129,4 +167,11 @@ cd _build/html
129167
python -m http.server 3001
130168
```
131169

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+

playground/config/settings.py

+3
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@
2525
MEDIA_ROOT = BASE_DIR / ".media"
2626

2727
# Custom
28+
LOGIN_URL = "admin:login"
29+
LOGIN_REDIRECT_URL = "admin:index"
30+
LOGOUT_REDIRECT_URL = "index"
2831
DATA_UPLOAD_MAX_MEMORY_SIZE = 2 * 1024 * 1024 # 2MB
2932
DEFAULT_AUTO_FIELD = "django.db.models.AutoField"
3033
AUTHENTICATION_BACKENDS = [

0 commit comments

Comments
 (0)