https://github.com/mrprotocoll/api-boilerplate-laravel

This Laravel 11 API boilerplate provides a structured foundation for building robust backend applications with Laravel, integrating essential features and tools.
https://github.com/mrprotocoll/api-boilerplate-laravel

boilerplate boilerplate-laravel laravel-11 laravel-11-boilerplate laravel-boi

Last synced: 28 days ago
JSON representation

This Laravel 11 API boilerplate provides a structured foundation for building robust backend applications with Laravel, integrating essential features and tools.

• Host: GitHub
• URL: https://github.com/mrprotocoll/api-boilerplate-laravel
• Owner: mrprotocoll
• Created: 2024-07-05T20:13:59.000Z (4 months ago)
• Default Branch: 0.1
• Last Pushed: 2024-07-12T13:46:51.000Z (4 months ago)
• Last Synced: 2024-07-12T15:12:36.300Z (4 months ago)
• Topics: boilerplate, boilerplate-laravel, laravel-11, laravel-11-boilerplate, laravel-boi
• Language: PHP
• Homepage:
• Size: 155 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  
🕹️🕹️ Laravel API Boilerplate🕹️🕹️

  






# 📗 Table of Contents

- [📖 About the Project](#about-project)

    - [🛠 Built With](#built-with)

        - [Tech Stack](#tech-stack)

    - [🚀 Links](#api-docs)

    - [Features](#features)

- [💻 Getting Started](#getting-started)

    - [Setup](#setup)

    - [Prerequisites](#prerequisites)

    - [Usage](#usage)

- [🤝 Contributing](#contributing)

# 📖  API Boilerplate 

**[Idara API]** is a boilerplate for building API applications using Laravel 11, incorporating Domain-Driven Design (DDD), role-based authentication, and various other features.

### Tech Stack 

- PHP

- Laravel

(back to top)


## 🚀 Links 

To access the documentation goto the below link

- Link to api routes

```

http://localhost:8000/v1

```

- Link to documentation

```

http://localhost:8000/v1/documentation

```




(back to top)


## 💻 Getting Started 

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this boilerplate, you need:

1. PHP ^8.2 


   use the following link to setup `PHP` if you dont have it already installed on your computer

(install PHP)


2. Composer 


   use the following link to Download `Composer` if you dont have it already installed on your computer

(install Composer)


## Install

```

composer create-project mrprotocoll/laravel-api-boilerplate my-api

```

Install dependencies:

```

composer install

```

## Setup

create .env file, change using the .env.example file and update the Database, Google Oauth (optional), and Email credentials.

```

cp .env.example .env

```

Generate keys, Run the migration and seed roles:

```

php artisan key:generate 

php artisan migrate --seed

```

### Usage

The following command can be used to run the application.

```sh

  php artisan serve

```

(back to top)