From d980f5139fd59d5b039d0f2e4d34f360b0e51dd5 Mon Sep 17 00:00:00 2001 From: Eric Simons Date: Fri, 21 Apr 2017 02:52:31 -0700 Subject: [PATCH] Update FRONTEND_INSTRUCTIONS.md --- FRONTEND_INSTRUCTIONS.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/FRONTEND_INSTRUCTIONS.md b/FRONTEND_INSTRUCTIONS.md index de8ffe604c..513c458e94 100644 --- a/FRONTEND_INSTRUCTIONS.md +++ b/FRONTEND_INSTRUCTIONS.md @@ -1,5 +1,29 @@ > *Note: Delete this file before publishing your app!* +### Using the hosted API + +Simply point your [API requests](../api/) to `https://conduit.productionready.io/api` and you're good to go! + +### 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 + # Styles Instead of having the Bootstrap theme included locally, we recommend loading the precompiled theme from our CDN (our [header template](#header) does this by default):