Aaron-Riley/Simple-CRUD-API

<<<<<<< HEAD

About Laravel

Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:

• Simple, fast routing engine.
• Powerful dependency injection container.
• Multiple back-ends for session and cache storage.
• Expressive, intuitive database ORM.
• Database agnostic schema migrations.
• Robust background job processing.
• Real-time event broadcasting.

Laravel is accessible, powerful, and provides tools required for large, robust applications.

Learning Laravel

Laravel has the most extensive and thorough documentation and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.

You may also try the Laravel Bootcamp, where you will be guided through building a modern Laravel application from scratch.

If you don't feel like reading, Laracasts can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.

Laravel Sponsors

We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the Laravel Partners program.

Premium Partners

• Vehikl
• Tighten Co.
• WebReinvent
• Kirschbaum Development Group
• 64 Robots
• Curotec
• Cyber-Duck
• DevSquad
• Jump24
• Redberry
• Active Logic
• byte5
• OP.GG

Contributing

Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the Laravel documentation.

Code of Conduct

In order to ensure that the Laravel community is welcoming to all, please review and abide by the Code of Conduct.

Security Vulnerabilities

If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via taylor@laravel.com. All security vulnerabilities will be promptly addressed.

License

The Laravel framework is open-sourced software licensed under the MIT license.

Simple CRUD API Project

Table of Contents

• About
• Getting Started
• Installing
• Usage
• Contributing

About

This project is a simple CRUD (Create, Read, Update, Delete) API built using PHP Laravel framework. It provides endpoints for managing blog posts, allowing users to create, retrieve, update, and delete posts. This project can be used as a template for users portfolio's.

Getting Started

These instructions will help you set up the project on your local machine for development and testing purposes.

Prerequisites

Before you begin, make sure you have the following installed:

• PHP >= 7.3
• Composer
• MySQL
• Git

Installing

1. Clone the repository:

   git clone https://github.com/Aaron-Riley/Simple-CRUD-API.git

2. Install dependencies using Composer:

   composer install

3. Set up your environment variables by copying the .env.example file to .env:

   cp .env.example .env

4. Update the database configuration in the .env file with your MySQL credentials.
5. Generate an application key:

   php artisan key:generate

6. Run the database migrations to create the necessary tables:

   php artisan migrate
   

Usage

Once the API is set up, you can use tools like Postman or curl to interact with the endpoints. Here are the available endpoints:

• GET /posts: Retrieve all blog posts
• POST /posts: Create a new blog post
• GET /posts/{id}: Retrieve a single blog post by its ID
• PUT /posts/{id}: Update an existing blog post
• DELETE /posts/{id}: Delete a blog post by its ID

Make sure to replace {id} with the actual ID of the blog post when making requests to the individual post endpoints.

Contributing

Contributions are welcome! If you'd like to contribute to this project, please fork the repository and submit a pull request.

origin/main