django-allauth-ui


Namedjango-allauth-ui JSON
Version 1.5.1 PyPI version JSON
download
home_pagehttps://github.com/danihodovic/django-allauth-ui
SummaryNone
upload_time2024-10-31 13:40:23
maintainerNone
docs_urlNone
authorDani Hodovic
requires_python>=3.8
licenseMIT
keywords django allauth social-login auth
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # AllAuth UI

![django-allauth-ui](./django-allauth-vs-allauth-ui.png)


UI templates for [django-allauth](https://github.com/pennersr/django-allauth)
built with Tailwind. https://django-allauth-ui.hodovi.ch.

django-allauth is a great library, but the templates it provides out of the box
are minimal html. I usually end up re-designing the login / logout / signup
pages for each new Django project. This library aims at providing good
defaults for new projects.

## Table of contents

* [Features](#features)
* [Installation](#installation)
* [Configuration](#configuration)
* [Hacking on the project](#hacking-on-the-project)
* [Contributors](#contributors)

## Features

- 📱 Mobile-friendly design
- 💄 [Configurable themes](https://daisyui.com/docs/themes/)
- 🕵️ Support for [Allauth User Sessions](https://docs.allauth.org/en/latest/usersessions/index.html)
- 📱Support for [Multi-Factor Authentication](https://docs.allauth.org/en/latest/mfa/index.html)
- 🗣️ Translations
  - 🇪🇸 Spanish
  - 🇫🇷 French
  - 🇧🇷 Portuguese
  - 🇹🇷 Turkish

## Installation

```
pip install django-allauth-ui
pip install django-widget-tweaks
pip install slippers
```

django-allauth-ui depends on [jazzband/django-widget-tweaks](https://github.com/jazzband/django-widget-tweaks)
and [mixxorz/slippers](https://github.com/mixxorz/slippers) to render templates. Make
sure to install both packages and add them to the INSTALLED_APPS.

Add django-allauth-ui **before** django-allauth in your INSTALLED_APPS. See
[./tests/settings.py](./tests/settings.py) for an example.

```python
INSTALLED_APPS = [
    "allauth_ui",
    "allauth",
    "allauth.account",
    "allauth.socialaccount",
    "allauth.socialaccount.providers.github",
    "widget_tweaks",
    "slippers",
]
```
**Note**:

When going to **production** you should run ```python manage.py collectstatic```

## Configuration

The templates can be themed using Django settings. The theme value corresponds to [DaisyUI themes](https://daisyui.com/docs/themes/).

```python
# settings.py
ALLAUTH_UI_THEME = "light"
```

## Hacking on the project

```sh
# Clone the repo
git clone git@github.com:danihodovic/django-allauth-ui.git
cd django-allauth-ui.git

# Create the virtual env
python -m venv .venv
# Activate the virtual env. This has to be done every time you enter the directory.
source .venv/bin/activate

# Install the dependencies
pip install --upgrade pip poetry
poetry install

# Install tailwind
npm install

# Run the migrations
./manage.py migrate

# Add sample social providers
./manage.py create_test_providers

# Start the server
./manage.py runserver_plus

# Start the tailwind compilation process in another terminal
npm run-script build:watch
```

Make changes in allauth_ui/templates and open the browser at http://localhost:8000/accounts/login/.

Once you're done compile tailwind with `npm run-script build` and submit a pull-request 🃏

## Contributors
<a href="https://github.com/danihodovic/django-allauth-ui/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=danihodovic/django-allauth-ui" />
</a>

Made with [contrib.rocks](https://contrib.rocks).

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/danihodovic/django-allauth-ui",
    "name": "django-allauth-ui",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "django, allauth, social-login, auth",
    "author": "Dani Hodovic",
    "author_email": "you@example.com",
    "download_url": "https://files.pythonhosted.org/packages/89/ab/62160d925048ab00c9297471575fa9ddd3faf0128fe01bdac642bafbb325/django_allauth_ui-1.5.1.tar.gz",
    "platform": null,
    "description": "# AllAuth UI\n\n![django-allauth-ui](./django-allauth-vs-allauth-ui.png)\n\n\nUI templates for [django-allauth](https://github.com/pennersr/django-allauth)\nbuilt with Tailwind. https://django-allauth-ui.hodovi.ch.\n\ndjango-allauth is a great library, but the templates it provides out of the box\nare minimal html. I usually end up re-designing the login / logout / signup\npages for each new Django project. This library aims at providing good\ndefaults for new projects.\n\n## Table of contents\n\n* [Features](#features)\n* [Installation](#installation)\n* [Configuration](#configuration)\n* [Hacking on the project](#hacking-on-the-project)\n* [Contributors](#contributors)\n\n## Features\n\n- \ud83d\udcf1 Mobile-friendly design\n- \ud83d\udc84 [Configurable themes](https://daisyui.com/docs/themes/)\n- \ud83d\udd75\ufe0f Support for [Allauth User Sessions](https://docs.allauth.org/en/latest/usersessions/index.html)\n- \ud83d\udcf1Support for [Multi-Factor Authentication](https://docs.allauth.org/en/latest/mfa/index.html)\n- \ud83d\udde3\ufe0f Translations\n  - \ud83c\uddea\ud83c\uddf8 Spanish\n  - \ud83c\uddeb\ud83c\uddf7 French\n  - \ud83c\udde7\ud83c\uddf7 Portuguese\n  - \ud83c\uddf9\ud83c\uddf7 Turkish\n\n## Installation\n\n```\npip install django-allauth-ui\npip install django-widget-tweaks\npip install slippers\n```\n\ndjango-allauth-ui depends on [jazzband/django-widget-tweaks](https://github.com/jazzband/django-widget-tweaks)\nand [mixxorz/slippers](https://github.com/mixxorz/slippers) to render templates. Make\nsure to install both packages and add them to the INSTALLED_APPS.\n\nAdd django-allauth-ui **before** django-allauth in your INSTALLED_APPS. See\n[./tests/settings.py](./tests/settings.py) for an example.\n\n```python\nINSTALLED_APPS = [\n    \"allauth_ui\",\n    \"allauth\",\n    \"allauth.account\",\n    \"allauth.socialaccount\",\n    \"allauth.socialaccount.providers.github\",\n    \"widget_tweaks\",\n    \"slippers\",\n]\n```\n**Note**:\n\nWhen going to **production** you should run ```python manage.py collectstatic```\n\n## Configuration\n\nThe templates can be themed using Django settings. The theme value corresponds to [DaisyUI themes](https://daisyui.com/docs/themes/).\n\n```python\n# settings.py\nALLAUTH_UI_THEME = \"light\"\n```\n\n## Hacking on the project\n\n```sh\n# Clone the repo\ngit clone git@github.com:danihodovic/django-allauth-ui.git\ncd django-allauth-ui.git\n\n# Create the virtual env\npython -m venv .venv\n# Activate the virtual env. This has to be done every time you enter the directory.\nsource .venv/bin/activate\n\n# Install the dependencies\npip install --upgrade pip poetry\npoetry install\n\n# Install tailwind\nnpm install\n\n# Run the migrations\n./manage.py migrate\n\n# Add sample social providers\n./manage.py create_test_providers\n\n# Start the server\n./manage.py runserver_plus\n\n# Start the tailwind compilation process in another terminal\nnpm run-script build:watch\n```\n\nMake changes in allauth_ui/templates and open the browser at http://localhost:8000/accounts/login/.\n\nOnce you're done compile tailwind with `npm run-script build` and submit a pull-request \ud83c\udccf\n\n## Contributors\n<a href=\"https://github.com/danihodovic/django-allauth-ui/graphs/contributors\">\n  <img src=\"https://contrib.rocks/image?repo=danihodovic/django-allauth-ui\" />\n</a>\n\nMade with [contrib.rocks](https://contrib.rocks).\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": null,
    "version": "1.5.1",
    "project_urls": {
        "Homepage": "https://github.com/danihodovic/django-allauth-ui",
        "Repository": "https://github.com/danihodovic/django-allauth-ui"
    },
    "split_keywords": [
        "django",
        " allauth",
        " social-login",
        " auth"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7e28b89f2ef25c64ac70595a24a5687d145abab8d87f288ac9f3c7d581417901",
                "md5": "ce161ce7d5af7d1ccc466a53fe616bcd",
                "sha256": "4b69d7209dac83946823ed14071adc3e8ccc3cb94b543c0ea0f575d747cee9b8"
            },
            "downloads": -1,
            "filename": "django_allauth_ui-1.5.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ce161ce7d5af7d1ccc466a53fe616bcd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 56622,
            "upload_time": "2024-10-31T13:40:21",
            "upload_time_iso_8601": "2024-10-31T13:40:21.971086Z",
            "url": "https://files.pythonhosted.org/packages/7e/28/b89f2ef25c64ac70595a24a5687d145abab8d87f288ac9f3c7d581417901/django_allauth_ui-1.5.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "89ab62160d925048ab00c9297471575fa9ddd3faf0128fe01bdac642bafbb325",
                "md5": "10cf94421855c2309bb3fc276bdfbe03",
                "sha256": "31485740884dc6e2ed5a380fc7a4c056ed22035eeee650d9e33433322537af20"
            },
            "downloads": -1,
            "filename": "django_allauth_ui-1.5.1.tar.gz",
            "has_sig": false,
            "md5_digest": "10cf94421855c2309bb3fc276bdfbe03",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 39101,
            "upload_time": "2024-10-31T13:40:23",
            "upload_time_iso_8601": "2024-10-31T13:40:23.394723Z",
            "url": "https://files.pythonhosted.org/packages/89/ab/62160d925048ab00c9297471575fa9ddd3faf0128fe01bdac642bafbb325/django_allauth_ui-1.5.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-31 13:40:23",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "danihodovic",
    "github_project": "django-allauth-ui",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "django-allauth-ui"
}
Dani Hodovic
Elapsed time: 1.81821s