Skip to content
The Readable project is part of the React course from Udacity
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
api-server
frontend
.gitignore
LICENSE
README.md

README.md

Readable By Michael Eisenbraun

What is Readable

Readable is a blog like site. This is my version of the Readable App, which is the final assessment project for Udacity's React & Redux course, developed by React Training.

The api-server was developed by Udacity. The full repository can be found on GitHub.

Installation

Installing and Starting API Server

In a terminal window, execute the following commands: - cd api-server - npm install - node server

Installing and Starting the React Project

In another terminal window, execute the following commands - cd frontend - npm install - npm start

Usage

After the servers are running, the site can be view in the browser by going to http://localhost:3000

Posts Page (Main Page)

The posts page display all of the posts in order of their vote score with highest vote score first.

This order can be changed using the sorter, which switches between ordering by vote score and date. Clicking on the same option a second time will reverse the order.

Category Pages

There is a page for each category that displays all the posts in that specific category in order of their vote score with highest vote score first.

This order can be changed using the sorter, which switches between ordering by vote score and date. Clicking on the same option a second time will reverse the order.

Clicking on the post title will take you to the post details page for that specific post.

You can vote up or down a post from this page, by clicking on the + or - button next to the vote score.

You can also create new posts from this page, by clicking on the + button.

Post Page

This is a details view of the each post. It also show the comments for the post.

You are able to edit the post by clicking on the pencil button or delete the post by clicking on the trash button.

You are able to create new comment by using the comment form found below the list of comments.

Existing comments can be edited or deleted using the pencil or trash buttons, which appear when hovering over the comment.

Existing comments can also be upvoted or downvoted by using the + or - button next to the comments vote score.

Personal Note

On a personal note, I found redux to be a lot like roundabouts. I love the idea of it, but HATE using it in practice.

However, I learned a lot throughout this project. I went down a lot wrong paths, and discovered different and better ways of doing similar tasks. But due time constraints, I did not have time to go back and fix some of the old code.

So, while the project is functional, I don't believe I am doing thing in the most efficient manner, and given more time, I would like to refactor and clean up the code.

License

The Readable frontend (/frontend) is Copyright © 2017 Michael Eisenbraun. It is free software, and may be redistributed under the terms specified in the LICENSE file.

You can’t perform that action at this time.