Skip to content

Commit

Permalink
docs: Add new features style
Browse files Browse the repository at this point in the history
  • Loading branch information
@mkleszcz
mkleszcz committed Aug 2, 2024
1 parent c9e88c3 commit c3895ab
Show file tree
Hide file tree
Showing 8 changed files with 111 additions and 167 deletions.
Binary file removed .github/images/features/ai.png
View file
Binary file not shown.
Binary file modified .github/images/features/auth.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .github/images/features/cms.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .github/images/features/emails.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .github/images/features/multitenancy.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .github/images/features/payments.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .github/images/features/subscriptions.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
278 changes: 111 additions & 167 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,173 +45,6 @@ Say goodbye to weeks of setup and coding. Our proven stack and ready-to-use feat
project and prioritize building your product's intellectual property. Unlock your SaaS potential faster than ever before
and seamlessly transition from setup to innovation.

## Features

<details open>
<summary>
This boilerplate includes plenty of ready to use features that you can adjust to you needs:
</summary> <br />

<div style="margin-bottom: 10px;">
<a href="https://docs.demo.saas.apptoku.com/introduction/features/auth" align="left">
<img src="./.github/images/features/auth.png" alt="Authentication and authorization" align="left" style="width: 49%;" />
</a>

<h3><a href="https://docs.demo.saas.apptoku.com/introduction/features/auth">Authentication and authorization</a></h3>
<p style="padding-left: 10px;">
<ul>
<li>User registration and login, including Facebook and Google OAuth</li>
<li>Basic user data like name, surname, and user role for authorization</li>
<li>User email address verification via a transactional email</li>
<li>Password change and password recovery within the app flow</li>
<li>User management panel in Django admin</li>
<li>Two-factor authentication</li>
</ul>
</p>

</div>

&nbsp;

<div align="center" style="margin-bottom: 10px;">
<div style="display: flex; align-items: flex-start; justify-content: space-between;">
<a href="https://docs.demo.saas.apptoku.com/introduction/features/auth" style="width: 49%;">
<img src="./.github/images/features/auth.png" alt="Authentication and authorization" />
</a>
<div style="margin-left: 20px; text-align: left; width: 51%;">
<h3><a href="https://docs.demo.saas.apptoku.com/introduction/features/auth">Authentication and authorization</a></h3>
<p>
<ul>
<li>User registration and login, including Facebook and Google OAuth</li>
<li>Basic user data like name, surname, and user role for authorization</li>
<li>User email address verification via a transactional email</li>
<li>Password change and password recovery within the app flow</li>
<li>User management panel in Django admin</li>
<li>Two-factor authentication</li>
</ul>
</p>
</div>
</div>
</div>

<div align="center" style="margin-bottom: 10px;">
<div style="display: flex; align-items: flex-start; justify-content: space-between;">
<div style="margin-right: 20px; text-align: left; width: 51%;">
<h3><a href="https://docs.demo.saas.apptoku.com/introduction/features/emails">Emails</a></h3>
<p>
<ul>
<li>A set of ready-to-send transactional emails (new user verification, password recovery, subscription renewals, errors, etc.)</li>
<li>Ability to schedule emails at a given time</li>
<li>Sending test emails directly from a Storybook</li>
<li>Internationalization support out of the box</li>
</ul>
</p>
</div>
<a href="https://docs.demo.saas.apptoku.com/introduction/features/emails" style="width: 49%;">
<img src="./.github/images/features/emails.png" alt="Emails" />
</a>
</div>
</div>

<div align="center" style="margin-bottom: 10px;">
<div style="display: flex; align-items: flex-start; justify-content: space-between;">
<a href="https://docs.demo.saas.apptoku.com/introduction/features/payments" style="width: 49%;">
<img src="./.github/images/features/payments.png" alt="Payments" />
</a>
<div style="margin-left: 20px; text-align: left; width: 51%;">
<h3><a href="https://docs.demo.saas.apptoku.com/introduction/features/payments">Payments</a></h3>
<p>
<ul>
<li>Integration with Stripe services and its dashboard</li>
<li>No customer payment method data is stored locally</li>
<li>Support for multiple payment methods and their management (storing for future use and removal)</li>
</ul>
</p>
</div>
</div>
</div>

<div align="center" style="margin-bottom: 10px;">
<div style="display: flex; align-items: flex-start; justify-content: space-between;">
<div style="margin-right: 20px; text-align: left; width: 51%;">
<h3><a href="https://docs.demo.saas.apptoku.com/introduction/features/payments#subscription-management">Subscriptions</a></h3>
<p>
<ul>
<li>Ability to charge users immediately or to set up recurring payments</li>
<li>Subscription plans support and ability to freely modify current plans</li>
<li>Free trial subscription plan, a grace period for credit card issues</li>
<li>Superadmin panel enables customer management (i.e. refunds) without the Stripe dashboard</li>
</ul>
</p>
</div>
<a href="https://docs.demo.saas.apptoku.com/introduction/features/payments#subscription-management" style="width: 49%;">
<img src="./.github/images/features/subscriptions.png" alt="Subscriptions" />
</a>
</div>
</div>

<div align="center" style="margin-bottom: 10px;">
<div style="display: flex; align-items: flex-start; justify-content: space-between;">
<a href="https://docs.demo.saas.apptoku.com/introduction/features/multi-tenancy" style="width: 49%;">
<img src="./.github/images/features/multitenancy.png" alt="Multi-tenancy" />
</a>
<div style="margin-left: 20px; text-align: left; width: 51%;">
<h3><a href="https://docs.demo.saas.apptoku.com/introduction/features/multi-tenancy">Multi-tenancy</a></h3>
<p>
<ul>
<li>Start immediately with a default tenant provided upon account creation</li>
<li>Add new tenants as needed to manage multiple entities within a single account</li>
<li>Utilize three default roles ”Owner, Admin, and Member” to control tenant activities and collaboration</li>
<li>Securely invite and manage new members within each tenant</li>
</ul>
</p>
</div>
</div>
</div>

<div align="center" style="margin-bottom: 10px;">
<div style="display: flex; align-items: flex-start; justify-content: space-between;">
<div style="margin-right: 20px; text-align: left; width: 51%;">
<h3><a href="https://docs.demo.saas.apptoku.com/introduction/features/cms">CMS integration (Contentful)</a></h3>
<p>
<ul>
<li>Integration with Contentful service</li>
<li>Example content model (image, title, and description)</li>
<li>Ready to use CMS with a free plan</li>
</ul>
</p>
</div>
<a href="https://docs.demo.saas.apptoku.com/introduction/features/cms" style="width: 49%;">
<img src="./.github/images/features/cms.png" alt="CMS integration (Contentful)" />
</a>
</div>
</div>

<div align="center" style="margin-bottom: 10px;">
<div style="display: flex; align-items: flex-start; justify-content: space-between;">
<a href="https://docs.demo.saas.apptoku.com/introduction/features/openai" style="width: 49%;">
<img src="./.github/images/features/ai.png" alt="OpenAI integration" />
</a>
<div style="margin-left: 20px; text-align: left; width: 51%;">
<h3><a href="https://docs.demo.saas.apptoku.com/introduction/features/openai">OpenAI integration</a></h3>
<p>
<ul>
<li>Seamless integration with OpenAI API</li>
<li>Built-in example generates SaaS ideas based on user input</li>
</ul>
</p>
</div>
</div>
</div>

---

</details>

... and more

The full list with the descriptions can be found in the [features documentation](https://docs.demo.saas.apptoku.com/introduction/features/).

## Getting started

### Requirements
Expand Down Expand Up @@ -307,6 +140,117 @@ In order to run your local documentation server execute following command:
pnpm saas docs up
```

## Features

<details open>
<summary>
This boilerplate includes plenty of ready to use features that you can adjust to you needs:
</summary> <br />

<a href="https://docs.demo.saas.apptoku.com/introduction/features/auth">
<img src="./.github/images/features/auth.png" alt="Authentication and authorization" />
</a>

<details open>
<summary>
<a href="https://docs.demo.saas.apptoku.com/introduction/features/auth">Authentication and authorization</a>
</summary><br/>
<ul>
<li>User registration and login, including Facebook and Google OAuth</li>
<li>Basic user data like name, surname, and user role for authorization</li>
<li>User email address verification via a transactional email</li>
<li>Password change and password recovery within the app flow</li>
<li>User management panel in Django admin</li>
<li>Two-factor authentication</li>
</ul>
</details>

<a href="https://docs.demo.saas.apptoku.com/introduction/features/emails">
<img src="./.github/images/features/emails.png" alt="Emails" />
</a>

<details open>
<summary>
<a href="https://docs.demo.saas.apptoku.com/introduction/features/emails">Emails</a>
</summary><br/>
<ul>
<li>A set of ready-to-send transactional emails (new user verification, password recovery, subscription renewals, errors, etc.)</li>
<li>Ability to schedule emails at a given time</li>
<li>Sending test emails directly from a Storybook</li>
<li>Internationalization support out of the box</li>
</ul>
</details>

<a href="https://docs.demo.saas.apptoku.com/introduction/features/payments">
<img src="./.github/images/features/payments.png" alt="Payments" />
</a>

<details open>
<summary>
<a href="https://docs.demo.saas.apptoku.com/introduction/features/payments">Payments</a>
</summary><br/>
<ul>
<li>Integration with Stripe services and its dashboard</li>
<li>No customer payment method data is stored locally</li>
<li>Support for multiple payment methods and their management (storing for future use and removal)</li>
</ul>
</details>

<a href="https://docs.demo.saas.apptoku.com/introduction/features/payments#subscription-management">
<img src="./.github/images/features/subscriptions.png" alt="Subscriptions" />
</a>

<details open>
<summary>
<a href="https://docs.demo.saas.apptoku.com/introduction/features/payments#subscription-management">Subscriptions</a>
</summary><br/>
<ul>
<li>Ability to charge users immediately or to set up recurring payments</li>
<li>Subscription plans support and ability to freely modify current plans</li>
<li>Free trial subscription plan, a grace period for credit card issues</li>
<li>Superadmin panel enables customer management (i.e. refunds) without the Stripe dashboard</li>
</ul>
</details>

<a href="https://docs.demo.saas.apptoku.com/introduction/features/multi-tenancy">
<img src="./.github/images/features/multitenancy.png" alt="Multi-tenancy" />
</a>

<details open>
<summary>
<a href="https://docs.demo.saas.apptoku.com/introduction/features/multi-tenancy">Multi-tenancy</a>
</summary><br/>
<ul>
<li>Start immediately with a default tenant provided upon account creation</li>
<li>Add new tenants as needed to manage multiple entities within a single account</li>
<li>Utilize three default roles ”Owner, Admin, and Member” to control tenant activities and collaboration</li>
<li>Securely invite and manage new members within each tenant</li>
</ul>
</details>

<a href="https://docs.demo.saas.apptoku.com/introduction/features/cms">
<img src="./.github/images/features/cms.png" alt="CMS integration (Contentful)" />
</a>

<details open>
<summary>
<a href="https://docs.demo.saas.apptoku.com/introduction/features/cms">CMS integration &#40;Contentful&#41;</a>
</summary><br/>
<ul>
<li>Integration with Contentful service</li>
<li>Example content model (image, title, and description)</li>
<li>Ready to use CMS with a free plan</li>
</ul>
</details>

---

</details>

... and more

The full list with the descriptions can be found in the [features documentation](https://docs.demo.saas.apptoku.com/introduction/features/).

## Tech stack

Front-end stack:
Expand Down

0 comments on commit c3895ab

Please sign in to comment.