diff --git a/BACKEND_INSTRUCTIONS.md b/BACKEND_INSTRUCTIONS.md deleted file mode 100644 index 28b51b2c63..0000000000 --- a/BACKEND_INSTRUCTIONS.md +++ /dev/null @@ -1,5 +0,0 @@ -> *Note: Delete this file before publishing your app!* - -# [Backend API spec](https://github.com/gothinkster/realworld/tree/master/api) - -For your convenience, we have a [Postman collection](https://github.com/gothinkster/realworld/blob/master/api/Conduit.postman_collection.json) that you can use to test your API endpoints as you build your app. diff --git a/FRONTEND_INSTRUCTIONS.md b/FRONTEND_INSTRUCTIONS.md deleted file mode 100644 index de680bc8a6..0000000000 --- a/FRONTEND_INSTRUCTIONS.md +++ /dev/null @@ -1,529 +0,0 @@ -> *Note: Delete this file before publishing your app!* - -### Using the hosted API - -Simply point your [API requests](https://github.com/gothinkster/realworld/tree/master/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): - -```html - -``` - -Alternatively, if you want to make modifications to the theme, check out the [theme's repo](https://github.com/gothinkster/conduit-bootstrap-template). - - -# Templates - -- [Layout](#layout) - - [Header](#header) - - [Footer](#footer) -- [Pages](#pages) - - [Home](#home) - - [Login/Register](#loginregister) - - [Profile](#profile) - - [Settings](#settings) - - [Create/Edit Article](#createedit-article) - - [Article](#article) - - -## Layout - - -### Header - -```html - - - - - Conduit - - - - - - - - - - - -``` - -### Footer -```html - - - - -``` - -## Pages - -### Home -```html -
- - - -
-
- -
-
- -
- -
-
- -
- Eric Simons - January 20th -
- -
- -

How to build webapps that scale

-

This is the description for the post.

- Read more... - -
- -
-
- -
- Albert Pai - January 20th -
- -
- -

The song you won't ever stop singing. No matter how hard you try.

-

This is the description for the post.

- Read more... - -
- -
- -
-
-

Popular Tags

- -
- programming - javascript - emberjs - angularjs - react - mean - node - rails -
-
-
- -
-
- -
-``` - -### Login/Register - -```html -
-
-
- -
-

Sign up

-

- Have an account? -

- -
    -
  • That email is already taken
    • -
- -
-
- -
-
- -
-
- -
- -
-
- -
-
-
-``` - -### Profile - -```html -
- -
-
-
- -
- -

Eric Simons

-

- Cofounder @GoThinkster, lived in Aol's HQ for a few months, kinda looks like Peeta from the Hunger Games -

- -
- -
-
-
- -
-
- -
-
- -
- -
-
- -
- Eric Simons - January 20th -
- -
- -

How to build webapps that scale

-

This is the description for the post.

- Read more... - -
- -
-
- -
- Albert Pai - January 20th -
- -
- -

The song you won't ever stop singing. No matter how hard you try.

-

This is the description for the post.

- Read more... -
    -
  • Music
    • -
  • Song
    • -
- -
- - -
- -
-
- -
-``` - -### Settings - -```html -
-
-
- -
-

Your Settings

- -
-
-
- -
-
- -
-
- -
-
- -
-
- -
- -
-
-
- -
-
-
-``` - -### Create/Edit Article - -```html -
-
-
- -
-
-
-
- -
-
- -
-
- -
-
-
-
- -
-
-
- -
-
-
- - -``` - -### Article - -```html -
- - - -
- -
-
-

- Web development technologies have evolved at an incredible clip over the past few years. -

-

Introducing RealWorld.

-

It's a great solution for learning how other frameworks work.

-
-
- -
- -
-
- -
- Eric Simons - January 20th -
- - -   - -
-
- -
- -
- -
-
- -
-
- - -
-
- -
-
-

With supporting text below as a natural lead-in to additional content.

-
-
- - - -   - Jacob Schmidt - Dec 29th -
-
- -
-
-

With supporting text below as a natural lead-in to additional content.

-
-
- - - -   - Jacob Schmidt - Dec 29th - - - - -
-
- -
- -
- -
- -
-``` diff --git a/MOBILE_INSTRUCTIONS.md b/MOBILE_INSTRUCTIONS.md deleted file mode 100644 index 46fac29669..0000000000 --- a/MOBILE_INSTRUCTIONS.md +++ /dev/null @@ -1,13 +0,0 @@ -> *Note: Delete this file before publishing your app!* - -# [Mobile Icons (iOS/Android)](https://github.com/gothinkster/realworld/tree/master/spec/mobile_icons) - -### Using the hosted API - -Simply point your [API requests](https://github.com/gothinkster/realworld/tree/master/api) to `https://conduit.productionready.io/api` and you're good to go! - -### Styles/Templates - -Unfortunately, there isn't a common way for us to reuse & share styles/templates for cross-platform mobile apps. - -Instead, we recommend using the Medium.com [iOS](https://itunes.apple.com/us/app/medium/id828256236?mt=8) and [Android](https://play.google.com/store/apps/details?id=com.medium.reader&hl=en) apps as a "north star" regarding general UI functionality/layout, but try not to go too overboard otherwise it will unnecessarily complicate your codebase (in other words, [KISS](https://en.wikipedia.org/wiki/KISS_principle) :) diff --git a/readme.md b/README.md similarity index 100% rename from readme.md rename to README.md