Skip to content

arslanhashmi/readable

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Readable

Readable is a Blog. Users are able to post content to predefined categories, they can comment on posts, vote on posts and comments. They can also edit/delete posts and comments.

Getting Started

Following are the steps to test/develop Readable:

  1. Fork, clone or download this repository

  2. Install and start back-end server.

    1. cd api-server
    2. npm install
    3. node server
  3. In another terminal window, do the following to start and run the readable app.

    1. cd frontend
    2. npm install
    3. npm start
  4. A browser window should open automatically, or you can load the app at http://localhost:3000

Technical Implementation Details

The Readable user interface is built using React while state management is handled by Redux. Other tools/frameworks/middlewares used in the project include:

API Server

More information on the Backend Server can be found here.