Skip to content

Commit

Permalink
Update README.md, login/logout redirect change
Browse files Browse the repository at this point in the history
  • Loading branch information
LeeHanYeong committed Dec 8, 2021
1 parent b90df15 commit 26049ff
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 3 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
/.media
/.static
/playground/.static
/playground/.media

# Created by https://www.gitignore.io/api/git,node,linux,macos,django,python,windows,pycharm+all,webstorm+all,visualstudiocode
# Edit at https://www.gitignore.io/?templates=git,node,linux,macos,django,python,windows,pycharm+all,webstorm+all,visualstudiocode
Expand Down
51 changes: 48 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@

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

## Live Demo

#### https://quill.lhy.kr/

- Form | https://quill.lhy.kr/posts/create/normal/
- ModelForm | https://quill.lhy.kr/posts/create/
- Form (Initial HTML) | https://quill.lhy.kr/posts/create/normal/html/
- Form (Initial Text) | https://quill.lhy.kr/posts/create/normal/text/
- Admin | https://quill.lhy.kr/admin/login/



## Documentation
Expand Down Expand Up @@ -76,12 +86,40 @@ class QuillPostAdmin(admin.ModelAdmin):



## docker-compose up (in local)


## Running the Live Demo project in local

The live demo is a deployment of the **"playground"** package, which is a django application within this library.
After cloning or downloading the repository, you can try running the live demo locally.

**A Python virtual environment is required to run the project.**

```shell
docker-compose -f docker-compose-local.yml up --build --force-recreate --remove-orphans
# [Optional] We recommend that you start after creating a folder for your project.
mkdir ~/projects
cd projects

# Clone repository
git clone git@github.com:LeeHanYeong/django-quill-editor.git

# Go to the project directory and apply the virtual environment
cd django-quill-editor
# [apply venv]

# Go to the playground package
cd playground

# Install requirements
pip install -r requirements.txt

# Run migrate and runserver
python manage.py migrate
python manage.py runserver
```

After the above operation, the live demo site works at localhost:8000.



## Contributing
Expand Down Expand Up @@ -129,4 +167,11 @@ cd _build/html
python -m http.server 3001
```




### docker-compose up (in local)

```shell
docker-compose -f docker-compose-local.yml up --build --force-recreate --remove-orphans
```

3 changes: 3 additions & 0 deletions playground/config/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@
MEDIA_ROOT = BASE_DIR / ".media"

# Custom
LOGIN_URL = "admin:login"
LOGIN_REDIRECT_URL = "admin:index"
LOGOUT_REDIRECT_URL = "index"
DATA_UPLOAD_MAX_MEMORY_SIZE = 2 * 1024 * 1024 # 2MB
DEFAULT_AUTO_FIELD = "django.db.models.AutoField"
AUTHENTICATION_BACKENDS = [
Expand Down

0 comments on commit 26049ff

Please sign in to comment.