diff --git a/docs/installation/examples.rst b/docs/installation/examples.rst new file mode 100644 index 0000000000..29d850c3f7 --- /dev/null +++ b/docs/installation/examples.rst @@ -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 +`_ +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 +`__. +You can see this project running live over at `django.demo.allauth.org +`__. + + +React Single-Page Application +----------------------------- + +The `React example application +`_ +demonstrates how the allauth headless API can be put to use in practice. The +documentation can be found in the `README +`_. 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 `_. diff --git a/docs/installation/index.rst b/docs/installation/index.rst index 29e30cd31f..c05be93aab 100644 --- a/docs/installation/index.rst +++ b/docs/installation/index.rst @@ -7,3 +7,4 @@ Installation requirements quickstart + examples