Skip to content

Latest commit

 

History

History
991 lines (677 loc) · 45 KB

README.md

File metadata and controls

991 lines (677 loc) · 45 KB
Raw

React + Redux Example App

Redux codebase containing real world examples (CRUD, auth, advanced patterns, etc)

The codebase is now feature complete and the RFC is open. Your input is greatly appreciated; please submit bug fixes via pull requests & feedback via issues.

Getting started

To get the frontend running locally:

  • Clone this repo
  • npm install to install all req'd dependencies
  • npm run watch to have webpack bundle the JS files into /bin/main.js, then run npm start

Functionality overview

The example application is a social blogging site (i.e. a Medium.com clone) 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

The general page breakdown looks like this:

  • 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 )
    • Use JWT (store the token in localStorage)
  • 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: /#/@username, /#/@username/favorites )
    • Show basic user info
    • List of articles populated from author's created articles or author's favorited articles