Surf
πββοΈ
Introduction
Surf, the opinionated Software as a Service Starter Kit that can help you build your next great idea
- Authentication
- User Profiles
- User Impersonation
- Subscriptions
- Subscription Plans
- User Roles
- Notifications
- Announcements
- Fully Functional Blog
- Out of the Box API
- Voyager Admin
- Customizable Themes
Deployment Issues
Surf has not been tested with DigitalOceans APP platform. If you are using Surf on DigitalOcean, don't be surprised if you experience issues. Docker has also not been tested and is not recommended.
Installation
To install Surf, you'll want to clone or download this repo:
git clone https://github.com/thinkverse/surf.git project_name
Next, we can install Surf with these 5 simple steps:
1. Create a New Database
We'll need to utilize a MySQL database during the installation. For the following stage, you'll need to create a new database and preserve the credentials.
2. Copy the .env.example file
We need to specify our Environment variables for our application. You will see a file named .env.example, you will need to duplicate that file and rename it to .env.
Then, open up the .env file and update your DB_DATABASE, DB_USERNAME, and DB_PASSWORD in the appropriate fields. You will also want to update the APP_URL to the URL of your application.
APP_URL=http://surf.test
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=surf
DB_USERNAME=root
DB_PASSWORD=
3. Add Composer Dependencies
Following that, we'll need to install all composer dependencies through the following command:
composer install
4. Update Paddle Plans
To make sure your plan IDs are up-to-date, you'll need to update the PlansTableSeeder.
To create a Paddle plan, navigate to your Paddle account and click on Catalogue Β» Subscription Plans.
Use the sandbox-vendors.paddle.com account for testing, and vendors.paddle.com account for production.
Update the plan_id, price, trial_days, etc. in the plans seeder array.
'name' => 'Basic',
'slug' => 'basic',
'description' => 'Signup for the Basic User Plan to access all the basic features.',
- 'plan_id' => '1',
+ 'plan_id' => '12345',
'default' => 0,
'price' => '5',
'trial_days' => 0,
5. Run Migrations and Seeds
We must migrate our database schema into our database, which we can accomplish by running the following command:
php artisan migrate
Finally, we will need to seed our database with the following command:
php artisan db:seed
That's it! You will now be able to visit your URL and see your Surf application up and running.
Watch, Learn, and Build
DevDojo got a full video series on how you can setup, build, and configure Wave, which is the underlying starter kit Surf is made from. You can watch first few videos for free, and additional videos will require a DevDojo Pro subscription. By subscribing to a DevDojo Pro subscription you will also be supporting the ongoing development of this project. It's a win win!
Click here to watch the Wave Video Series.
Documentation
Checkout the official Wave documentation here.
Support Wave
Give Wave and DevDojo support by following DevDojo on Twitter and upvoting them on Product Hunt.
![[Feat Request]Laravel Sail](https://avatars.githubusercontent.com/u/884602?v=4)
16 Dec 23, 2022
8 Nov 24, 2022
2 Dec 23, 2022
400 Dec 29, 2022
83 Dec 26, 2022
30 Oct 11, 2022
1 Nov 20, 2021
32 Nov 24, 2022
1 Dec 31, 2020
1.1k Jan 5, 2023
50 Jan 4, 2023
862 Jan 4, 2023
121 Dec 31, 2022
848 Dec 28, 2022
17 Nov 18, 2022
16 Nov 16, 2022
10 Aug 3, 2022
16 Jun 15, 2023