Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/f1amy/laravel-realworld-example-app
Exemplary RealWorld backend API built with Laravel PHP framework.
https://github.com/f1amy/laravel-realworld-example-app
backend ci crud demo-app jwt laravel realworld rest-api
Last synced: 3 days ago
JSON representation
Exemplary RealWorld backend API built with Laravel PHP framework.
- Host: GitHub
- URL: https://github.com/f1amy/laravel-realworld-example-app
- Owner: f1amy
- License: mit
- Created: 2021-05-21T06:28:00.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-03T09:20:52.000Z (about 1 year ago)
- Last Synced: 2024-08-01T19:45:37.828Z (3 months ago)
- Topics: backend, ci, crud, demo-app, jwt, laravel, realworld, rest-api
- Language: PHP
- Homepage: https://realworld.io
- Size: 565 KB
- Stars: 88
- Watchers: 4
- Forks: 114
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
[](https://github.com/gothinkster/realworld)
[](https://github.com/f1amy/laravel-realworld-example-app/actions/workflows/tests.yml)
[](https://codecov.io/gh/f1amy/laravel-realworld-example-app)
[](https://github.com/f1amy/laravel-realworld-example-app/actions/workflows/static-analysis.yml)
[](https://opensource.org/licenses/MIT)
> Example of a PHP-based Laravel application containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld) API spec.
This codebase was created to demonstrate a backend application built with [Laravel framework](https://laravel.com/) including RESTful services, CRUD operations, authentication, routing, pagination, and more.
We've gone to great lengths to adhere to the **Laravel framework** community style guides & best practices.
For more information on how to this works with other frontends/backends, head over to the [RealWorld](https://github.com/gothinkster/realworld) repo.
## How it works
The API is built with [Laravel](https://laravel.com/), making the most of the framework's features out-of-the-box.
The application is using a custom JWT auth implementation: [`app/Jwt`](./app/Jwt).
## Getting started
The preferred way of setting up the project is using [Laravel Sail](https://laravel.com/docs/sail),
for that you'll need [Docker](https://docs.docker.com/get-docker/) under Linux / macOS (or Windows WSL2).
### Installation
Clone the repository and change directory:
git clone https://github.com/f1amy/laravel-realworld-example-app.git
cd laravel-realworld-example-app
Install dependencies (if you have `composer` locally):
composer create-project
Alternatively you can do the same with Docker:
docker run --rm -it \
--volume $PWD:/app \
--user $(id -u):$(id -g) \
composer create-project
Start the containers with PHP application and PostgreSQL database:
./vendor/bin/sail up -d
(Optional) Configure a Bash alias for `sail` command:
alias sail='[ -f sail ] && bash sail || bash vendor/bin/sail'
Migrate the database with seeding:
sail artisan migrate --seed
## Usage
The API is available at `http://localhost:3000/api` (You can change the `APP_PORT` in `.env` file).
### Run tests
sail artisan test
### Run PHPStan static analysis
sail php ./vendor/bin/phpstan
### OpenAPI specification (not ready yet)
Swagger UI will be live at [http://localhost:3000/api/documentation](http://localhost:3000/api/documentation).
For now, please visit the specification [here](https://github.com/gothinkster/realworld/tree/main/api).
## Contributions
Feedback, suggestions, and improvements are welcome, feel free to contribute.
## License
The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.