Example Laravel codebase containing real world examples (CRUD, auth, advanced patterns and more) that adheres to the RealWorld spec and API.
This repo is functionality complete β PRs and issues welcome!
Getting started
Installation
Please check the official laravel installation guide for server requirements before you start. Official Documentation
Alternative installation is possible without local dependencies relying on Docker.
Clone the repository
git clone [email protected]:gothinkster/laravel-realworld-example-app.git
Switch to the repo folder
cd laravel-realworld-example-app
Install all the dependencies using composer
composer install
Copy the example env file and make the required configuration changes in the .env file
cp .env.example .env
Generate a new application key
php artisan key:generate
Generate a new JWT authentication secret key
php artisan jwt:generate
Run the database migrations (Set the database connection in .env before migrating)
php artisan migrate
Start the local development server
php artisan serve
You can now access the server at http://localhost:8000
TL;DR command list
git clone [email protected]:gothinkster/laravel-realworld-example-app.git
cd laravel-realworld-example-app
composer install
cp .env.example .env
php artisan key:generate
php artisan jwt:generate
Make sure you set the correct database connection information before running the migrations Environment variables
php artisan migrate
php artisan serve
Database seeding
Populate the database with seed data with relationships which includes users, articles, comments, tags, favorites and follows. This can help you to quickly start testing the api or couple a frontend and start using it with ready content.
Open the DummyDataSeeder and set the property values as per your requirement
database/seeds/DummyDataSeeder.php
Run the database seeder and you're done
php artisan db:seed
Note : It's recommended to have a clean database before seeding. You can refresh your migrations at any point to clean the database by running the following command
php artisan migrate:refresh
Docker
To install with Docker, run following commands:
git clone [email protected]:gothinkster/laravel-realworld-example-app.git
cd laravel-realworld-example-app
cp .env.example.docker .env
docker run -v $(pwd):/app composer install
cd ./docker
docker-compose up -d
docker-compose exec php php artisan key:generate
docker-compose exec php php artisan jwt:generate
docker-compose exec php php artisan migrate
docker-compose exec php php artisan db:seed
docker-compose exec php php artisan serve --host=0.0.0.0
The api can be accessed at http://localhost:8000/api.
API Specification
This application adheres to the api specifications set by the Thinkster team. This helps mix and match any backend with any other frontend without conflicts.
More information regarding the project can be found here https://github.com/gothinkster/realworld
Code overview
Dependencies
- jwt-auth - For authentication using JSON Web Tokens
- laravel-cors - For handling Cross-Origin Resource Sharing (CORS)
Folders
app- Contains all the Eloquent modelsapp/Http/Controllers/Api- Contains all the api controllersapp/Http/Middleware- Contains the JWT auth middlewareapp/Http/Requests/Api- Contains all the api form requestsapp/RealWorld/Favorite- Contains the files implementing the favorite featureapp/RealWorld/Filters- Contains the query filters used for filtering api requestsapp/RealWorld/Follow- Contains the files implementing the follow featureapp/RealWorld/Paginate- Contains the pagination class used to paginate the resultapp/RealWorld/Slug- Contains the files implementing slugs to articlesapp/RealWorld/Transformers- Contains all the data transformersconfig- Contains all the application configuration filesdatabase/factories- Contains the model factory for all the modelsdatabase/migrations- Contains all the database migrationsdatabase/seeds- Contains the database seederroutes- Contains all the api routes defined in api.php filetests- Contains all the application teststests/Feature/Api- Contains all the api tests
Environment variables
.env- Environment variables can be set in this file
Note : You can quickly set the database information and other variables in this file and have the application fully working.
Testing API
Run the laravel development server
php artisan serve
The api can now be accessed at
http://localhost:8000/api
Request headers
| Required | Key | Value |
|---|---|---|
| Yes | Content-Type | application/json |
| Yes | X-Requested-With | XMLHttpRequest |
| Optional | Authorization | Token {JWT} |
Refer the api specification for more info.
Authentication
This applications uses JSON Web Token (JWT) to handle authentication. The token is passed with each request using the Authorization header with Token scheme. The JWT authentication middleware handles the validation and authentication of the token. Please check the following sources to learn more about JWT.
Cross-Origin Resource Sharing (CORS)
This applications has CORS enabled by default on all API endpoints. The default configuration allows requests from http://localhost:3000 and http://localhost:4200 to help speed up your frontend testing. The CORS allowed origins can be changed by setting them in the config file. Please check the following sources to learn more about CORS.