Laravel Starter Kit is a development tool to quickly launch startups. It includes pre-built components for projects using Vue or Tailwind, streamlining setup with features like authentication, billing, and database management. Designed to reduce repetitive coding and integrate with popular frameworks, it offers both Lite and Full versions.
Features
Stack Choices
Choose between Tailwind CSS, Alpine.js, and Livewire or Inertia.js and Vue.js for front-end development.
CRUD Generator
Automatically generates CRUD operations for your application to speed up initial development.
Role Management
Built-in role management system that allows you to define user permissions and roles easily.
Authentication
Pre-built authentication system using Laravel Breeze to streamline login and registration processes.
Dashboard Integration
Includes a starter dashboard template to help you set up and customize your admin panel.
Profile Management
User profile management features are included, such as updating user information.
Installation Guide
Provides step-by-step instructions on setting up the Artiplate SaaS starter package, including cloning the repository, installing PHP and Node.js dependencies, and running the project.
Environment Configuration
Guidance on editing the .env file for setting environment variables like app name and URL.
PHP and Node Version Requirements
Lists specific PHP, NPM, and Node.js versions required to run the project.
Database Setup
Instructions for integrating a database if needed, including migrations and optional configuration for authentication and subscriptions.
SMTP Setup
Optional setup instructions for configuring SMTP server settings for sending emails from the app.
Project Cloning
Clone the project from GitHub and navigate into the directory.
Composer Package Installation
Install necessary composer packages using 'composer install'.
Environment Setup
Copy and update the environment variables in the .env file.
App Key Generation
Generate an application key using the Artisan command.
Node Package Installation
Install required node packages with 'npm install'.
Project Execution
Run the project using 'npm run start' to start PHP artisan server and npm run dev.
Database Setup
Optional setup for database to authenticate users, use magic links, or create subscriptions. Migrate database tables if needed.
SMTP Mail Setup
Optional setup for sending emails through SMTP.
NewsletterSignUp Component
Automatically adds emails to /storage/app/waiting-list-signups.txt and sends a default welcome email. Users can customize or disable the email feature.
Magic Links
Allows users to authenticate by sending a magic link to their email. Users click the link to be logged in without needing to remember a password.
Single Sign On
Enables users to authenticate using a third-party provider, allowing them to log in with credentials from providers like Google or Facebook.
Email & Password
Standard authentication method allowing users to create an account and log in with their email and a password.
Account Configuration
Guides you through setting up a new Stripe account including the addition of branding, enabling email notifications, and setting security preferences.
Product Creation
Describes how to create a product in Stripe by creating a new product, adding the price ID, and obtaining API keys.
Webhooks Setup
Explains the setup of Stripe webhooks to allow the application to receive payment updates and other events.
Theme Management
Allows you to select and customize themes for your site using pre-made or custom themes defined in Tailwind CSS. Themes can be changed by editing specific files.
Theme Classes
Utilizes Tailwind CSS theme classes to define component colors. These are customizable in the tailwind.config.js file and affect how components appear throughout the site, such as text color and styling.
Privacy Policy and Terms of Service Templates
Provides templates for Privacy Policy and Terms of Service. These can be customized using ChatGPT prompts to fit specific business needs.
OAuth Setup with Stripe and OAuth Providers
Integrates with Stripe for payments and requires Privacy Policy and Terms of Service for OAuth providers like Github, Facebook, or Google.
Easy-to-follow Guide
Includes a guide to set up Privacy Policy and Terms of Service pages easily through the provided repository.
SQLite Setup
To set up SQLite, create a database file using the command 'touch database/database.sqlite' in the terminal, then update DB_CONNECTION to SQLite in the .env file, removing other database variables.
MySQL Setup
For MySQL, create a new database in the terminal using 'mysql -u root -p' and 'CREATE DATABASE your_db_name;'. Update the .env file with MySQL connection details like DB_HOST, DB_PORT, DB_DATABASE, DB_USERNAME, and DB_PASSWORD.
PostgreSQL Setup
Create a new PostgreSQL database by using 'psql -U <your_db_username>' and 'CREATE DATABASE your_db_name;'. Update the .env file with DB_CONNECTION as pgsql and other connection details.
Resend Integration
Provides instructions to set up email sending using Resend. You can set up DNS records and verify them in the Resend dashboard.
SMTP Configuration
Guides on configuring SMTP settings in the .env file for sending emails from your application.
Mailtrap Integration
Instructions for using Mailtrap for local development to test email sending without reaching real users.
Checkout Sessions
Allows users to set up payment pages using Stripe for one-time payments. Users need to copy a price ID from their products and use the checkout.one-off route to create a checkout page. After payment completion, users are redirected to a success URL.
Subscriptions
Enables setting up recurring payments using Stripe. Users copy a product's price ID, add it to their env file, and incorporate a SubscriptionToggleButton component to manage the subscription. After subscription setup or cancellation, users are redirected and sent confirmation emails.
GitHub SSO Integration
Allows users to authenticate using their GitHub account. Users must create a new OAuth App in GitHub, fill in necessary details, and use the application callback URL provided. Client ID and Client Secret are then added to the environment file.
Google SSO Integration
Enables users to sign in through their Google account. Users create a project on Google Cloud Console and configure the credentials. The application callback URL must be specified, and Client ID and Client Secret need to be copied to the environment file.
Facebook SSO Integration
Permits users to authenticate using Facebook. Users need to create a new app in Facebook's Developer portal, specify the callback URL, and copy the Client ID and Client Secret to the environment file.
Magic Links
Magic links allow users to authenticate without passwords. A unique URL is sent to the user's email, and clicking it automatically logs them in. To enable, set `ALLOW_MAGIC_LINK_LOGIN=true` in the `.env` file and run `php artisan optimize`. Users can then request a link at `/login/magic-link`. To make magic links the default login, edit `/resources/js/Components/NavBar.vue` and change the `href` to `/login/magic-link`.
Default SEO Metatags
The default SEO metatags are located in the resources/view/app.blade.php file. You can configure the description, keywords, and social tags for your site here.
SEO Sitemap Generation
Artiplate uses the spatie/laravel-sitemap package to generate a sitemap for your site. You can configure settings like URLs and routes in App/Console/Commands/GenerateSitemap, then run the artisan command to create the sitemap.
Google Analytics Integration
Allows you to easily add Google Analytics to your project. You need to add your Google Analytics ID to the .env file. Once done, the ID is included in the google tag manager script in the app.blade.php file.
Blog Module
Artiplate provides a complete blog module that can be customized. It improves SEO and can be used with different data sources.
Routes
Comprises routes for accessing the blog: /blog and /blog/{slug}. Allows for specific page creation and SEO optimization.
Data Source Customization
Current content is accessed from /storage/app/blog-posts.json. The data source can be changed via BlogPostController, allowing integration with services like Contentful or DatoCMS or using a database.