Back to Dashboard

Laravel Restify Starter Kit

Complete installation guide for your Laravel API project

Ready to use starter kit

This starter kit includes authentication, user management, teams, roles & permissions, and invitations system out of the box.

Requirements

✓ PHP ^8.2
✓ Laravel ^12.0
✓ Composer 2.x
✓ MySQL/PostgreSQL/SQLite

Installation Steps

1 Download the Starter Kit

First, download the starter kit by clicking the download button on the dashboard.

# The starter kit will be downloaded as a ZIP file

2 Extract and Navigate

Extract the ZIP file and navigate to the project directory:

cd laravel-restify-starter-kit

3 Install Dependencies

Install PHP dependencies using Composer:

composer install

4 Environment Setup

Copy the example environment file and generate an application key:

cp .env.example .env
php artisan key:generate

5 Configure Database

Update your .env file with your database credentials: 

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=your_database_name
DB_USERNAME=your_username
DB_PASSWORD=your_password

6 Run Migrations

Create the database tables:

php artisan migrate

7 Seed Initial Data (Optional)

Optionally, seed the database with sample data:

php artisan db:seed

8 Start the Development Server

You can now start the Laravel development server:

php artisan serve

Your API will be available at http://localhost:8000

Available API Endpoints

After installation, the following endpoints will be available:

Authentication

POST /api/register
POST /api/login
POST /api/forgotPassword
POST /api/resetPassword
GET /api/restify/profile
PUT /api/restify/profile

User Management

GET /api/restify/users
POST /api/restify/users
GET /api/restify/users/{id}
PATCH /api/restify/users/{id}
DELETE /api/restify/users/{id}
POST /api/restify/users/{id}/sync/roles

Roles & Permissions

GET /api/restify/roles
GET /api/restify/roles/{id}
POST /api/restify/roles
GET /api/restify/permissions
POST /api/restify/roles/{id}/sync/permissions

Teams Management

GET /api/restify/teams
POST /api/restify/teams
GET /api/restify/teams/{id}
DELETE /api/restify/teams/{id}
POST /api/restify/teams/bulk
GET /api/restify/teams/{id}/users
POST /api/restify/teams/{id}/attach/users
POST /api/restify/teams/{id}/detach/users
POST /api/restify/teams/{id}/sync/users

Invitations

GET /api/restify/invitations
POST /api/restify/invitations
POST /api/restify/invitations/{id}/actions?action=resend-invitation-email
POST /api/restify/invitations/confirm

Postman Collection

The starter kit includes a complete Postman collection with all API endpoints pre-configured. You'll find it in the storage/postman folder.

Using with Laravel Valet or Herd

If you're using Laravel Valet or Laravel Herd, you can easily configure the Postman collection:

  1. Import the collection and environment files from storage/postman
  2. Go to Postman Environments
  3. Edit the api variable
  4. Replace it with your folder name (e.g., http://laravel-restify-starter-kit.test/api)

Default Configuration

By default, the Postman environment is configured for http://localhost:8000/api

Next Steps

Need help? Check out the full documentation or reach out to our community.

Full Documentation GitHub