SAAS Template with Nuxt 3, Bun, Supabase, Stripe, Pinia, and PrimeVue (Tailwind)

Description

This project is a robust SAAS template designed to kickstart your software as a service application. It utilizes Nuxt 3 for the frontend, Bun as the Node.js replacement and package manager, Supabase for backend and database solutions, Stripe for payment handling, Pinia for state management, and PrimeVue for UI components. Tailwind CSS is used for styling.

---

Table of Contents

• Features
• Installation
• Usage
• Frameworks and Libraries
• Contribution
• License

---

Features

• Authentication

  • Email & Password Sign Up
  • OAuth Sign Up (Google, GitHub, etc.)
  • Two-Factor Authentication
  • Password Reset

• User Management

  • Profile Editing
  • Role-based Access Control
  • Activity Tracking

• Billing & Payments

  • Stripe Integration
  • Subscription Management
  • Invoices

• API

  • RESTful API Endpoints
  • GraphQL Support
  • API Rate Limiting

• Frontend

  • Responsive Design
  • Dark Mode
  • Localization and Internationalization

• State Management

  • Global State Management (Pinia)
  • Local Storage

• Data Storage

  • File Uploads
  • Database CRUD Operations (Supabase)

• Security

  • Data Encryption
  • XSS Protection
  • CSRF Protection

• Real-time Features

  • Websockets
  • Notifications

• Customization & Theming

  • Pre-built UI Components (PrimeVue)
  • Custom Themes

• Documentation

  • API Documentation
  • User Guides
  • Developer Guides

---

Installation

Prerequisites

• Bun installed
• Stripe API keys
• Supabase project setup

Clone the Repository

git clone https://github.com/yourusername/SAAS-Template.git

Install Dependencies

Navigate into the project directory and run:

bun install

Environment Variables

Copy the .env.example file and rename it to .env. Then populate the necessary API keys and URLs.

cp .env.example .env

Start the Development Server

To start the development server, run:

bun dev

---

Usage

Once the server is up, head to http://localhost:3000/ to see the application in action.

To utilize Stripe's capabilities, make sure your Stripe API keys are filled in the .env file.

---

Frameworks and Libraries

• Nuxt 3: Next-gen Vue.js framework for building versatile web applications.
• Bun: A Node.js replacement and package manager to speed up your workflow.
• Supabase: Open-source Firebase alternative for backend and database solutions.
• Stripe: A comprehensive toolkit for internet commerce.
• Pinia: State management pattern and library.
• PrimeVue: Feature-rich set of UI components for Vue.js.
• Tailwind CSS: A utility-first CSS framework.

---

Contribution

Pull requests are welcome. For major changes, open an issue first to discuss your ideas.

---

License

MIT License - see the LICENSE.md file for details.

---

Made with ❤️ by Alexandre Mercier