django-allauth-ui

Name	django-allauth-ui JSON
Version	0.3.4 JSON
	download
home_page	https://github.com/danihodovic/django-webhook
Summary	None
upload_time	2024-05-21 20:07:22
maintainer	None
docs_url	None
author	Dani Hodovic
requires_python	<4.0.0,>=3.8
license	MIT
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

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

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 decent
defaults for new projects.

* [AllAuth UI](#allauth-ui)
* [Features](#features)
* [Installation](#installation)
* [Screenshots](#screenshots)
   * [Generating screenshots](#generating-screenshots)
* [Hacking on the project](#hacking-on-the-project)
* [Contributors](#contributors)

## Features

- Responsive design suitable for device sizes from mobile to desktop
- Styled social login themes
- Additional error information when [social logins fail](https://github.com/pennersr/django-allauth/issues/2142)

## Installation


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

django-allauth-ui depends on django-widget-tweaks to render form fields. Make
sure to install django-widget-tweaks and add it 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",
]
```
**Note**:

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

## Screenshots

![Log In](./images/signin.png)
![Sign Up](./images/signup.png)
![Password Reset](./images/password_reset.png)

### Generating screenshots

```
convert "$1" -crop 1072x901+436+200 crop_signin.png
```

### 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
[<img alt="EVELYN-RYAN" src="https://avatars.githubusercontent.com/u/72516405?v=4&s=117" width="117">](https://github.com/EVELYN-RYAN)[<img alt="filip-dobrovolny-csob-cz" src="https://avatars.githubusercontent.com/u/95356884?v=4&s=117" width="117">](https://github.com/filip-dobrovolny-csob-cz)[<img alt="mohmyo" src="https://avatars.githubusercontent.com/u/14170159?v=4&s=117" width="117">](https://github.com/mohmyo)[<img alt="twolfson" src="https://avatars.githubusercontent.com/u/902488?v=4&s=117" width="117">](https://github.com/twolfson)[<img alt="anyidea" src="https://avatars.githubusercontent.com/u/48710760?v=4&s=117" width="117">](https://github.com/anyidea)[<img alt="danihodovic" src="https://avatars.githubusercontent.com/u/5557301?v=4&s=117" width="117">](https://github.com/danihodovic)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/danihodovic/django-webhook",
    "name": "django-allauth-ui",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0.0,>=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/84/5d/8f4d51f9c120f1ff24a4768cbf316931f2e5f07c233f0398089db968379d/django_allauth_ui-0.3.4.tar.gz",
    "platform": null,
    "description": "# AllAuth UI\n\nUI templates for [django-allauth](https://github.com/pennersr/django-allauth)\nbuilt with Tailwind.\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 decent\ndefaults for new projects.\n\n* [AllAuth UI](#allauth-ui)\n* [Features](#features)\n* [Installation](#installation)\n* [Screenshots](#screenshots)\n   * [Generating screenshots](#generating-screenshots)\n* [Hacking on the project](#hacking-on-the-project)\n* [Contributors](#contributors)\n\n## Features\n\n- Responsive design suitable for device sizes from mobile to desktop\n- Styled social login themes\n- Additional error information when [social logins fail](https://github.com/pennersr/django-allauth/issues/2142)\n\n## Installation\n\n\n```\npip install django-allauth-ui\npip install django-widget-tweaks\n```\n\ndjango-allauth-ui depends on django-widget-tweaks to render form fields. Make\nsure to install django-widget-tweaks and add it 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]\n```\n**Note**:\n\nWhen going to **production** you should run ```python manage.py collectstatic```\n\n## Screenshots\n\n![Log In](./images/signin.png)\n![Sign Up](./images/signup.png)\n![Password Reset](./images/password_reset.png)\n\n### Generating screenshots\n\n```\nconvert \"$1\" -crop 1072x901+436+200 crop_signin.png\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[<img alt=\"EVELYN-RYAN\" src=\"https://avatars.githubusercontent.com/u/72516405?v=4&s=117\" width=\"117\">](https://github.com/EVELYN-RYAN)[<img alt=\"filip-dobrovolny-csob-cz\" src=\"https://avatars.githubusercontent.com/u/95356884?v=4&s=117\" width=\"117\">](https://github.com/filip-dobrovolny-csob-cz)[<img alt=\"mohmyo\" src=\"https://avatars.githubusercontent.com/u/14170159?v=4&s=117\" width=\"117\">](https://github.com/mohmyo)[<img alt=\"twolfson\" src=\"https://avatars.githubusercontent.com/u/902488?v=4&s=117\" width=\"117\">](https://github.com/twolfson)[<img alt=\"anyidea\" src=\"https://avatars.githubusercontent.com/u/48710760?v=4&s=117\" width=\"117\">](https://github.com/anyidea)[<img alt=\"danihodovic\" src=\"https://avatars.githubusercontent.com/u/5557301?v=4&s=117\" width=\"117\">](https://github.com/danihodovic)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": null,
    "version": "0.3.4",
    "project_urls": {
        "Homepage": "https://github.com/danihodovic/django-webhook",
        "Repository": "https://github.com/danihodovic/django-webhook"
    },
    "split_keywords": [
        "django",
        " allauth",
        " social-login",
        " auth"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8153adbacd23dc7b60485539774f1ea7afbd20f912b2a21bc472ad9b7ec74163",
                "md5": "dd0159081b8c5c5561505d388fba8286",
                "sha256": "bb91a3ccf1eb9e6d8eaabcc4a23f796d5686d34eb93b0ee60de193e3c1237af0"
            },
            "downloads": -1,
            "filename": "django_allauth_ui-0.3.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "dd0159081b8c5c5561505d388fba8286",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0.0,>=3.8",
            "size": 30719,
            "upload_time": "2024-05-21T20:07:20",
            "upload_time_iso_8601": "2024-05-21T20:07:20.635683Z",
            "url": "https://files.pythonhosted.org/packages/81/53/adbacd23dc7b60485539774f1ea7afbd20f912b2a21bc472ad9b7ec74163/django_allauth_ui-0.3.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "845d8f4d51f9c120f1ff24a4768cbf316931f2e5f07c233f0398089db968379d",
                "md5": "2e5c3a77abf1007a088f0f59c40f8a4b",
                "sha256": "b4f38f4dad44545c4fdc667ae2fa12c5825fee61c9f4fb438225d8da6199bed7"
            },
            "downloads": -1,
            "filename": "django_allauth_ui-0.3.4.tar.gz",
            "has_sig": false,
            "md5_digest": "2e5c3a77abf1007a088f0f59c40f8a4b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0.0,>=3.8",
            "size": 20623,
            "upload_time": "2024-05-21T20:07:22",
            "upload_time_iso_8601": "2024-05-21T20:07:22.758628Z",
            "url": "https://files.pythonhosted.org/packages/84/5d/8f4d51f9c120f1ff24a4768cbf316931f2e5f07c233f0398089db968379d/django_allauth_ui-0.3.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-21 20:07:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "danihodovic",
    "github_project": "django-webhook",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "django-allauth-ui"
}