From 8e0fcc18493ca185df50823a25750d29c14b61f6 Mon Sep 17 00:00:00 2001 From: Tony Lea Date: Wed, 23 Oct 2024 07:46:17 -0400 Subject: [PATCH] Adding updates to getting started --- content/docs/getting-started.md | 64 +++++++++++++++++---------------- 1 file changed, 33 insertions(+), 31 deletions(-) diff --git a/content/docs/getting-started.md b/content/docs/getting-started.md index d2abb9d..b9d1168 100644 --- a/content/docs/getting-started.md +++ b/content/docs/getting-started.md @@ -34,44 +34,46 @@ Wave has been built with the intention of helping anyone build their next great ### Key Features -Here's an overview of Wave's key features, which we'll explore in more detail later. - - - **Authentication** - Wave ships with authentication allowing users to Login, Register, Verify Email, Password Reset/Confirmation, and enable Two-Factor authentication. - - - **User Management** - Users can have roles and permissions to access certain parts of your app. Wave also includes features for impersonation, user management, and user profiles. - - - **Billing** - You can easily integrate Stripe or Paddle into your application. Create subscription plans and associate them with user roles to control access to specific features. - - - **Changelog** - Creating a changelog is a great way to notify users about new features and fixes while keeping yourself accountable. Document your progress in the changelog. - -- **Blog** - Write blog posts and attract free traffic from search engines. Share your knowledge about technology and tools as you build your SaaS. - -- **API** - API tokens can be created for API access. These tokens are used to generate Bearer tokens for authenticating future API requests. - -- **Admin** - Wave leverages FilamentPHP for admin CRUD functionality. You may also use the Table Builder, Form Builder, Notifications, and more within theme files. - -- **Themes** - Customize your app's look and feel with Wave's theming system. Each theme in `resources/themes` includes its own assets and views. +Below is a list of Waves key features. Click a feature to learn more. + + - **Authentication** + - **User Profiles** + - **User Impersonations** + - **Billing** + - **Subscription Plans** + - **Roles and Permissions** + - **User Notifications** + - **Changelog** + - **Blog** + - **Pages** + - **API** + - **Admin** + - **Themes** + - **Plug-ins** ### Under The Hood -Wave has been built with the Laravel Framework, alongside are many other popular technologies powering the propellers and steering the ship. +Below is a list of technologies that are being used to power the propellers and steer the ship. + +**Technologies Used** -**Technologies** +- Laravel +- Livewire +- Tailwind CSS +- Alpine +- Vite -- Livewire - Wave uses Livewire in each theme and many other areas. It makes building interactive applications fun and easy. -- FilamentPHP - Filament is used for the main Admin section for Wave. Along with Filament panels, you can also take advantage of the Filament Table Builder, Form Builder, and Notifications inside your theme files. -- Tailwind CSS - Tailwind makes it easy and simple to stylize your application. -- Alpine - Easily add in sprinkles of Javascript functionality with Alpine. Pairs perfectly with Livewire. -- Vite - We utilize the default Laravel Vite functionality to run and build assets for each theme. +Along with many technologies, Wave also utilizes a handful of packages. -**Packages** +**Packages Used** -- DevDojo Auth - We use the DevDojo Auth which gives you a full authenticaiton system in your app. -- DevDojo Themes - The themes functionality for Wave is extracted into it's own theme package. -- Impersonation Package - This package allows you to authenticate with, or impersonate, any user in your app. -- Spatie Roles (Permissions) Package - Wave utilizes the Spatie Permissions package to manage roles/permissions. -- Laravel Folio - Inside of each theme folder, you can include a `pages` directory and these will utilize Folio and be mapped to a route. -- Laravel Volt - Many folio pages utilize Volt for creating single-file functionality. +- FilamentPHP +- DevDojo Auth +- DevDojo Themes +- Impersonation Package +- Spatie Roles (Permissions) Package +- Laravel Folio +- Laravel Volt ## Demo