creativetimofficial / ct-headless-cms-with-laravel-json-api-pro

Laravel REST API with the help of json:api standard
5 stars 2 forks source link

Headless CMS with Laravel JSON:API PRO

version GitHub issues open GitHub issues closed

Product Image

Laravel Headless CMS follows the JSON:API standard for building APIs in JSON. JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. It`s specifically designed to increase efficiency by keeping the number of requests and the amount of data transmitted between clients and servers to a minimum.

Download

Download the .zip file from the Creative Tim site and extract it.

Laravel API Setup

Introduction

JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. It is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability.

Click here to go to the JSON:API docs

Prerequisites

The Laravel JSON:API backend project requires a proper multi-threaded web server such as Apache/Nginx environment with PHP, Composer and MySQL.

Do not use php artisan serve as it will result in stalled requests due to the single-threaded nature of the built-in PHP web server.

We strongly recommend using Laradock for Linux and Mac or Laragon for Windows if possible.

Other options for your local environment:

You will also need to install Composer 2: https://getcomposer.org/doc/00-intro.md

Laravel JSON:API Project Installation

  1. Navigate in your Laravel API project folder: cd your-laravel-json-api-project
  2. Install project dependencies: composer install
  3. Create a new .env file: cp .env.example .env
  4. Add your own database credentials in the .env file in DB_DATABASE, DB_USERNAME, DB_PASSWORD
  5. Create users table: php artisan migrate --seed
  6. Generate application key: php artisan key:generate
  7. Install Laravel Passport: php artisan passport:install
  8. Add your own mailtrap.io credentials in MAIL_USERNAME and MAIL_PASSWORD in the .env file

Usage

You can register as a user or log in using one of the default users:

A member type user can log in, update his profile and view a list of added items.
A creator type user can log in, update his profile and perform actions on categories, tags and items. A admin type user can log in, update his profile and perform actions on categories, tags, items, roles and users.

Headless CMS with Laravel JSON:API PRO provides basic CRUD endpoints for the most commonly used functionalities in any CMS.

Table of Contents

Versions

Documentation

The documentation for the Headless CMS with Laravel JSON:API PRO is hosted at our here.

Resources

Dashboards built with Headless CMS with Laravel JSON:API PRO

Vue Argon Dashboard Laravel Vue Material Dashboard Laravel
Vue Argon Dashboard Pro Laravel Vue Material Dashboard Laravel Pro
Vue Black Dashboard Laravel Vue White Dashboard Laravel
Vue Black Dashboard Pro Laravel Vue White Dashboard Pro Laravel
Vue Paper Dashboard Laravel Vue Now UI Dashboard Laravel
Vue Paper Dashboard Pro Laravel Vue Now UI Dashboard Pro Laravel
Nuxt Argon Dashboard Laravel
Nuxt Argon Dashboard Pro Laravel

Change log

Please see the changelog for more information on what has changed recently.

Reporting Issues

We use GitHub Issues as the official bug tracker for the Headless CMS with Laravel JSON:API PRO. Here are some advices for our users that want to report an issue:

  1. Make sure that you are using the latest version of the Headless CMS with Laravel JSON:API PRO. Check the CHANGELOG from your dashboard on our website.
  2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
  3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.

Licensing

Useful Links

Social Media

Creative Tim:

Twitter: https://twitter.com/CreativeTim?ref=hclja-readme

Facebook: https://www.facebook.com/CreativeTim?ref=hclja-readme

Dribbble: https://dribbble.com/creativetim?ref=hclja-readme

Instagram: https://www.instagram.com/CreativeTimOfficial?ref=hclja-readme

Updivision:

Twitter: https://twitter.com/updivision?ref=hclja-readme

Facebook: https://www.facebook.com/updivision?ref=hclja-readme

Linkedin: https://www.linkedin.com/company/updivision?ref=hclja-readme

Updivision Blog: https://updivision.com/blog/?ref=hclja-readme

Credits