https://github.com/mguinea/lumen-ddd-realworld-example
Backend implementation for RealWorld based on Lumen, DDD and Hexagonal architecture.
https://github.com/mguinea/lumen-ddd-realworld-example
api best-practices ddd hexagonal lumen monorepository php solid tdd
Last synced: 9 months ago
JSON representation
Backend implementation for RealWorld based on Lumen, DDD and Hexagonal architecture.
- Host: GitHub
- URL: https://github.com/mguinea/lumen-ddd-realworld-example
- Owner: mguinea
- Created: 2021-05-04T19:41:29.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-31T20:53:28.000Z (almost 5 years ago)
- Last Synced: 2025-04-18T19:41:32.726Z (about 1 year ago)
- Topics: api, best-practices, ddd, hexagonal, lumen, monorepository, php, solid, tdd
- Language: PHP
- Homepage:
- Size: 380 KB
- Stars: 10
- Watchers: 4
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 
> ### Lumen codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld) spec and API.
### [Demo](https://github.com/gothinkster/realworld) [RealWorld](https://github.com/gothinkster/realworld)
This codebase was created to demonstrate a fully fledged fullstack application built with **Lumen** including CRUD operations, authentication, routing, pagination, and more.
We've gone to great lengths to adhere to the **Lumen** community styleguides & 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
> Describe the general architecture of your app here TODO
# Getting started
> npm install, npm start, etc. TODO
# Resources
- https://jwt-auth.readthedocs.io/en/develop/lumen-installation/
- https://www.positronx.io/laravel-jwt-authentication-tutorial-user-login-signup-api/
# Conventions
# Endpoints overview
| Verb | Endpoint | Description |
|----------|----------|----------|
| POST | /api/users/login | Authentication |
| POST | /api/users | Registration |
| GET | /api/user | Current User |
| PUT | /api/user | Update User |
| GET | /api/profiles/:username | Get Profile |
| POST | /api/profiles/:username/follow | Follow User |
| DELETE | /api/profiles/:username/follow | Unfollow User |
| GET | /api/articles | List Articles |
| GET | /api/articles/feed | Feed Articles |
| GET | /api/articles/:slug | Get Article |
| POST | /api/articles | Create Article |
| PUT | /api/articles/:slug | Update Article |
| DELETE | /api/articles/:slug | Delete Article |
| POST | /api/articles/:slug/comments | Add Comments to an Article |
| GET | /api/articles/:slug/comments | Get Comments from an Article |
| DELETE | /api/articles/:slug/comments/:id | Delete Comment |
| POST | /api/articles/:slug/favorite | Favorite Article |
| DELETE | /api/articles/:slug/favorite | Unfavorite Article |
| GET | /api/tags | Get Tags |