Add README.md
This commit is contained in:
commit
910f5673d8
1 changed files with 37 additions and 0 deletions
37
README.md
Normal file
37
README.md
Normal file
|
@ -0,0 +1,37 @@
|
|||
### Laravel implementation of RealWorld app
|
||||
|
||||
This Laravel app is part of the [RealWorld](https://github.com/gothinkster/realworld) project and implementation of the [Laravel best practices](https://github.com/alexeymezenin/laravel-best-practices).
|
||||
|
||||
You might also check [Ruby on Rails version](https://github.com/alexeymezenin/ruby-on-rails-realworld-example-app) of this app.
|
||||
|
||||
See how the exact same Medium.com clone (called [Conduit](https://demo.realworld.io)) is built using different [frontends](https://codebase.show/projects/realworld?category=frontend) and [backends](https://codebase.show/projects/realworld?category=backend). Yes, you can mix and match them, because **they all adhere to the same [API spec](https://gothinkster.github.io/realworld/docs/specs/backend-specs/introduction)**
|
||||
|
||||
### How to run the API
|
||||
|
||||
Make sure you have PHP and Composer installed globally on your computer.
|
||||
|
||||
Clone the repo and enter the project folder
|
||||
|
||||
```
|
||||
git clone https://github.com/alexeymezenin/laravel-realworld-example-app.git
|
||||
cd laravel-realworld-example-app
|
||||
```
|
||||
|
||||
Install the app
|
||||
|
||||
```
|
||||
composer install
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
Run the web server
|
||||
|
||||
```
|
||||
php artisan serve
|
||||
```
|
||||
|
||||
That's it. Now you can use the api, i.e.
|
||||
|
||||
```
|
||||
http://127.0.0.1:8000/api/articles
|
||||
```
|
Loading…
Reference in a new issue