Updated README. #115
parent
7257fbffb3
commit
c9e800b5ab
61
README.md
61
README.md
|
|
@ -18,6 +18,8 @@ django-admin-interface is a modern **responsive flat admin interface customizabl
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
- Beautiful default **django-theme**
|
- Beautiful default **django-theme**
|
||||||
- Themes management and customization *(you can **customize admin title, logo and colors**)*
|
- Themes management and customization *(you can **customize admin title, logo and colors**)*
|
||||||
|
|
@ -37,6 +39,8 @@ django-admin-interface is a modern **responsive flat admin interface customizabl
|
||||||
- `django-tabbed-admin`
|
- `django-tabbed-admin`
|
||||||
- `sorl-thumbnail`
|
- `sorl-thumbnail`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
- Run `pip install django-admin-interface`
|
- Run `pip install django-admin-interface`
|
||||||
- Add `admin_interface`, `flat_responsive`, `flat` and `colorfield` to `settings.INSTALLED_APPS` **before** `django.contrib.admin`
|
- Add `admin_interface`, `flat_responsive`, `flat` and `colorfield` to `settings.INSTALLED_APPS` **before** `django.contrib.admin`
|
||||||
|
|
@ -66,6 +70,8 @@ SILENCED_SYSTEM_CHECKS = ['security.W019']
|
||||||
- Run ``python manage.py collectstatic --clear``
|
- Run ``python manage.py collectstatic --clear``
|
||||||
- Restart your application server
|
- Restart your application server
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Optional themes
|
## Optional themes
|
||||||
This package ships with optional themes as fixtures, they can be installed using the [loaddata admin command](https://docs.djangoproject.com/en/1.11/ref/django-admin/#django-admin-loaddata). Optional themes are activated on installation.
|
This package ships with optional themes as fixtures, they can be installed using the [loaddata admin command](https://docs.djangoproject.com/en/1.11/ref/django-admin/#django-admin-loaddata). Optional themes are activated on installation.
|
||||||
|
|
||||||
|
|
@ -120,6 +126,7 @@ You can add **theme support to existing third-party libraries** using the follow
|
||||||
- `--admin-interface-related-modal-background-color`
|
- `--admin-interface-related-modal-background-color`
|
||||||
- `--admin-interface-related-modal-background-opacity`
|
- `--admin-interface-related-modal-background-opacity`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
###### Admin login
|
###### Admin login
|
||||||
|
|
@ -134,11 +141,50 @@ You can add **theme support to existing third-party libraries** using the follow
|
||||||
###### Admin theme customization
|
###### Admin theme customization
|
||||||

|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
- #### I already have a custom `base_site.html`, how can I make it work?
|
|
||||||
|
### Custom `base-site.html`
|
||||||
|
> I already have a custom `base_site.html`, how can I make it work?
|
||||||
|
|
||||||
You can use [django-apptemplates](https://github.com/bittner/django-apptemplates), then add `{% extends "admin_interface:admin/base_site.html" %}` to your `base_site.html`
|
You can use [django-apptemplates](https://github.com/bittner/django-apptemplates), then add `{% extends "admin_interface:admin/base_site.html" %}` to your `base_site.html`
|
||||||
|
|
||||||
|
### Language Chooser not showing
|
||||||
|
> I have enabled the **Language Chooser**, but it is not visible in the admin, what should I do?
|
||||||
|
|
||||||
|
You must configure multilanguage `settings` and `urls` correctly:
|
||||||
|
```python
|
||||||
|
LANGUAGES = (
|
||||||
|
('en', _('English')),
|
||||||
|
('it', _('Italiano')),
|
||||||
|
('fr', _('Française')),
|
||||||
|
# more than one language is expected here
|
||||||
|
)
|
||||||
|
LANGUAGE_CODE = 'en'
|
||||||
|
USE_I18N = True
|
||||||
|
MIDDLEWARE = [
|
||||||
|
# ...
|
||||||
|
'django.middleware.locale.LocaleMiddleware',
|
||||||
|
# ...
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
```python
|
||||||
|
from django.conf.urls.i18n import i18n_patterns
|
||||||
|
from django.contrib import admin
|
||||||
|
from django.urls import include, path
|
||||||
|
|
||||||
|
# ...
|
||||||
|
|
||||||
|
urlpatterns = [
|
||||||
|
path('i18n/', include('django.conf.urls.i18n')),
|
||||||
|
]
|
||||||
|
urlpatterns += i18n_patterns(path('admin/', admin.site.urls))
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
```bash
|
```bash
|
||||||
# create python virtual environment
|
# create python virtual environment
|
||||||
|
|
@ -162,22 +208,13 @@ python setup.py test
|
||||||
python -m django test --settings "tests.settings"
|
python -m django test --settings "tests.settings"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## License
|
## License
|
||||||
Released under [MIT License](LICENSE.txt).
|
Released under [MIT License](LICENSE.txt).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Supporting
|
|
||||||
|
|
||||||
I would like to spend more time on this project, especially to improve it and adding new features.
|
|
||||||
|
|
||||||
As everyone knows open-source projects takes up a lot of time that is unpaid. :money_with_wings:
|
|
||||||
|
|
||||||
If you are using this package in commercial project(s), please consider the idea to become a sponsor or donating once:
|
|
||||||
|
|
||||||
- [GitHub Sponsor](https://github.com/sponsors/fabiocaccamo)
|
|
||||||
- [PayPal](https://www.paypal.me/fabiocaccamo)
|
|
||||||
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [`django-colorfield`](https://github.com/fabiocaccamo/django-colorfield) - simple color field for models with a nice color-picker in the admin. 🎨
|
- [`django-colorfield`](https://github.com/fabiocaccamo/django-colorfield) - simple color field for models with a nice color-picker in the admin. 🎨
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue