diff --git a/CHANGELOG.md b/CHANGELOG.md index 854bb98..4abd4d7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,7 +20,7 @@ First Release version. If your package.json does not have a version attribute, This is what I did to create the project including all the extra fiddly stuff. Putting this here so I don't forget. ### Setup Nuxt -Follow instructions from here https://nuxt.com/docs/getting-started/installation +I Followed instructions from here https://nuxt.com/docs/getting-started/installation ```bash # install node diff --git a/README.md b/README.md index 3e15289..97c58e9 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,21 @@ -# Nuxt 3 (SAAS) Boilerplate +![SupaNuxt SaaS](assets/images/supanuxt_logo_200.png) + +# SupaNuxt SaaS [![Netlify Status](https://api.netlify.com/api/v1/badges/19d67f94-afdc-4b79-8490-600be26e85de/deploy-status)](https://app.netlify.com/sites/nuxt3-saas-boilerplate/deploys) ## Demo Sites -Boilerplate Demo site [here](https://nuxt3-saas-boilerplate.netlify.app/) +Demo site [here](https://nuxt3-saas-boilerplate.netlify.app/) Pottery Helper [here](https://potteryhelper.com/) ## Tech Stack -- Nuxt 3 (I like it, shut up) -- Supabase (Auth including OAuth + Postgresql instance) -- Prisma (Schema management + Strongly typed client) -- TRPC (Server/Client communication with Strong types, SSR compatible) -- Pinia (State Store. I liked vuex a lot, in particular explicit mutations but gotta go with the cool crowd) -- Stripe (Payments including Webhook integration) -- Tailwind + daisyUI (Tailwind because everybody is using it, daisyUI because I suck at tailwind) +- Nuxt 3 +- Supabase (auth including OAuth + Postgresql instance) +- Prisma (schema management + Strongly typed client) +- TRPC (server/client communication with Strong types, SSR compatible) +- Pinia (state Store) +- Stripe (payments including webhook integration) +- Tailwind + daisyUI (styling and components) - OpenAI (text completions with AI) ## Features @@ -102,7 +104,7 @@ This solution uses Supabase for Auth and to provide a DB. In addition to Magic 1) Go to [Supabase](https://supabase.com/) and 'Start your Project' 2) Setup your org and project (Free tier is fine to start) 3) Update the project's email template (Supabase -> Authentication -> Email Templates) -Note that the default Supabase email templates are very generic and for some reason this can lead to your emails being sent to spam folders. e.g. I to get my password reset emails to go to inbox, I needed to change the subject to "Password Reset for Nuxt 3 SAAS Boilerplate" and also the email body text. +Note that the default Supabase email templates are very generic and for some reason this can lead to your emails being sent to spam folders. e.g. I to get my password reset emails to go to inbox, I needed to change the subject to "Password Reset for ..." and also the email body text. 4) Choose an OAuth provider. I have chosen Google using these [Instructions](https://supabase.com/docs/guides/auth/social-login/auth-google) for the purposes of demonstration but they all should work. 5) Go to Project Settings -> API and copy Project URL and Project API Key to SUPABASE_URL and SUPABASE_KEY settings respectively in your [.env](/.env) file 6) Go to Project Settings -> Database -> Connection String -> URI and copy the uri value into the DATABASE_URL setting in your [.env](/.env) file, remembering to replace ```[YOUR-PASSWORD]``` with the password you provided when you setup the project. diff --git a/assets/images/supanuxt_logo_100.png b/assets/images/supanuxt_logo_100.png new file mode 100644 index 0000000..1a214a7 Binary files /dev/null and b/assets/images/supanuxt_logo_100.png differ diff --git a/assets/images/supanuxt_logo_200.png b/assets/images/supanuxt_logo_200.png new file mode 100644 index 0000000..667fca8 Binary files /dev/null and b/assets/images/supanuxt_logo_200.png differ diff --git a/assets/images/supanuxt_logo_400.png b/assets/images/supanuxt_logo_400.png new file mode 100644 index 0000000..38304b6 Binary files /dev/null and b/assets/images/supanuxt_logo_400.png differ diff --git a/assets/images/supanuxt_logo_800.png b/assets/images/supanuxt_logo_800.png new file mode 100644 index 0000000..f16d24c Binary files /dev/null and b/assets/images/supanuxt_logo_800.png differ diff --git a/components/AppHeader.vue b/components/AppHeader.vue index 8605294..e2e5c98 100644 --- a/components/AppHeader.vue +++ b/components/AppHeader.vue @@ -49,7 +49,7 @@
  • Sign In
  • - Nuxt3 SAAS Boilerplate + SupaNuxt SAAS @@ -105,7 +104,7 @@ const user = useSupabaseUser()

    User Management

    -

    Our Nuxt 3 SAAS Boilerplate project includes robust user management features, including +

    SupaNuxt SaaS includes robust user management features, including authentication with social login (oauth) or email/password, management of user roles and permissions, and multi-user/team accounts that permit multiple users to share plan features including a team administration facility and user roles within team. This is a great feature for businesses or community groups who want to @@ -134,7 +133,7 @@ const user = useSupabaseUser()

    Config and Environment

    -

    Nuxt 3 SAAS Boilerplate includes an approach to config and environment +

    SupaNuxt SaaS includes an approach to config and environment management that enables customisation and management of api keys.

    @@ -146,7 +145,7 @@ const user = useSupabaseUser()

    State Management

    -

    Nuxt 3 SAAS Boilerplate includes multi modal state management that supports both Single Page Application (SPA) +

    SupaNuxt SaaS includes multi modal state management that supports both Single Page Application (SPA) pages such as dashboards and Server Side Rendered (SSR) style pages for public content that are crawlable by Search engines like google and facilitate excellent Search Engine Optimisation (SEO).

    @@ -159,7 +158,7 @@ const user = useSupabaseUser()

    Stripe Integration

    -

    Nuxt 3 SAAS Boilerplate includes Stripe integration for subscription payments including +

    SupaNuxt SaaS includes Stripe integration for subscription payments including Subscription based support for multi pricing and multiple plans.

    @@ -171,7 +170,7 @@ const user = useSupabaseUser()

    Style System

    -

    Nuxt 3 SAAS Boilerplate includes Tailwind integration for site styling including a themable UI components with daisyUI

    +

    SupaNuxt SaaS includes Tailwind integration for site styling including a themable UI components with daisyUI

    diff --git a/pages/pricing.vue b/pages/pricing.vue index 50ea9ed..4c78b3c 100644 --- a/pages/pricing.vue +++ b/pages/pricing.vue @@ -13,7 +13,7 @@

    Flexible Pricing

    -

    Get started with the best boiler for your SAAS plate

    +

    SupaNuxt SaaS is completely free and open source but you can price your own SaaS like this