Skip to content

Commit

Permalink
Update FRONTEND_INSTRUCTIONS.md
Browse files Browse the repository at this point in the history
  • Loading branch information
EricSimons committed Apr 21, 2017
1 parent 0bb3e9f commit d980f51
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions FRONTEND_INSTRUCTIONS.md
Original file line number Diff line number Diff line change
@@ -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):
Expand Down

0 comments on commit d980f51

Please sign in to comment.