Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 2.42 KB

README.md

File metadata and controls

51 lines (37 loc) · 2.42 KB
Raw

Laravel Livewire codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld spec and API.

Demo    Github

This codebase was created to demonstrate a fully fledged fullstack application built with Laravel Livewire including CRUD operations, authentication, routing, pagination, and more.

We've gone to great lengths to adhere to the Laravel Livewire community styleguides & best practices.

For more information on how to this works with other frontends/backends, head over to the RealWorld repo.

Project Overview

"Conduit" is a social blogging site (i.e. a Medium.com clone). It uses a custom API for all requests, including authentication. You can view a live demo over at https://realworld-tall-app.fly.dev

General functionality:

  • Authenticate users via JWT (login/signup pages + logout button on settings page)
  • CRU* users (sign up & settings page - no deleting required)
  • CRUD Articles
  • CR*D Comments on articles (no updating required)
  • GET and display paginated lists of articles
  • Favorite articles
  • Follow other users

Routing Guidelines

  • Home page (URL: /#/ )
    • List of tags
    • List of articles pulled from either Feed, Global, or by Tag
    • Pagination for list of articles
  • Sign in/Sign up pages (URL: /#/login, /#/register )
    • Uses JWT (store the token in localStorage)
    • Authentication can be easily switched to session/cookie based
  • Settings page (URL: /#/settings )
  • Editor page to create/edit articles (URL: /#/editor, /#/editor/article-slug-here )
  • Article page (URL: /#/article/article-slug-here )
    • Delete article button (only shown to article's author)
    • Render markdown from server client side
    • Comments section at bottom of page
    • Delete comment button (only shown to comment's author)
  • Profile page (URL: /#/profile/:username, /#/profile/:username/favorites )
    • Show basic user info
    • List of articles populated from author's created articles or author's favorited articles

How it works

You can also access the back-end to the /api route.

License

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