Giter VIP home page Giter VIP logo

reactnd-project-readable-starter's Introduction

Readable API Server

Installation

Install packages: npm install Launch server: node server Unless modified in config.js server will use port 3001

API

Use an AuthorizationReactND header to work with your own data:

fetch(url, { headers: { 'AuthorizationReactND': 'whatever-you-want' }})

The following endpoints are available:

GET /categories
USAGE:
Get all of the categories available for the app. List is found in categories.js. Feel free to extend this list as you desire.

GET /:category/posts
USAGE:
Get all of the posts for a particular category

GET /posts
USAGE:
Get all of the posts. Useful for the main page when no category is selected.

POST /posts
USAGE:
Add a new post

PARAMS:
id - UUID should be fine, but any unique id will work
timestamp - timestamp in whatever format you like, you can use Date.now() if you like
title - String
body - String
owner - String
category: Any of the categories listed in categories.js. Feel free to extend this list as you desire.

GET /posts/:id
USAGE:
Get the details of a single post

POST /posts/:id
USAGE:
Used for voting on a post

PARAMS:
option - String: Either "upVote" or "downVote"

PUT /posts/:id
USAGE:
Edit the details of an existing post

PARAMS:
title - String
body - String

DELETE /posts/:id
USAGE:
Sets the deleted flag for a post to 'true'.
Sets the parentDeleted flag for all child comments to 'true'.

GET /posts/:id/comments
USAGE:
Get all the comments for a single post

POST /comments
USAGE:
Add a comment to a post

PARAMS:
id: Any unique ID. As with posts, UUID is probably the best here.
timestamp: timestamp. Get this however you want.
body: String
owner: String
parentId: Should match a post id in the database.

GET /comments/:id
USAGE:
Get the details for a single comment

POST /comments/:id
USAGE:
Used for voting on a comment.

PUT /comments/:id
USAGE:
Edit the details of an existing comment

PARAMS:
timestamp: timestamp. Get this however you want.
body: String

DELETE /comments/:id
USAGE:
Sets a comment's deleted flag to 'true'

reactnd-project-readable-starter's People

Contributors

forbiddenvoid avatar richardkalehoff avatar willkessler avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.