Skip to content

Commit

Permalink
docs: Added examples section
Browse files Browse the repository at this point in the history
  • Loading branch information
pennersr committed May 31, 2024
1 parent c5d4d54 commit 73efc84
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/installation/examples.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Example Projects
================

The source code repository contains fully functional example projects to help you get started.

Regular Django Project
----------------------

The `Regular Django project
<https://github.com/pennersr/django-allauth/tree/main/examples/regular-django>`_
is a Bootstrap styled example project, which provides an example of how allauth
can be styled without altering any of the builtin templates. Please take a look
at the `templates of the example project
<https://github.com/pennersr/django-allauth/tree/main/examples/regular-django/example/templates>`__.
You can see this project running live over at `django.demo.allauth.org
<https://django.demo.allauth.org>`__.


React Single-Page Application
-----------------------------

The `React example application
<https://github.com/pennersr/django-allauth/tree/main/examples/react-spa>`_
demonstrates how the allauth headless API can be put to use in practice. The
documentation can be found in the `README
<https://github.com/pennersr/django-allauth/tree/main/examples/react-spa/README.org>`_. Instructions
on how to run it locally can be found there as well, though you can also view a
copy running over at `react.demo.allauth.org <https://react.demo.allauth.org>`_.
1 change: 1 addition & 0 deletions docs/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ Installation

requirements
quickstart
examples

0 comments on commit 73efc84

Please sign in to comment.