Skip to content

README.md

Latest commit

 

History

History
60 lines (36 loc) · 2.29 KB

README.md

File metadata and controls

60 lines (36 loc) · 2.29 KB
Raw

Readable Project

This is the starter project of Udacity's Redux. Users will be able to post content to predefined categories, comment on their posts and other users' posts, and vote on posts and comments. Users will also be able to edit and delete posts and comments.

Installation instructions

These instructions will help you install the app on your local machine.

Prerequisites

Make sure you have Git and Node installed, before you proceed.

1. Clone the repositors to your local machine

To clone and run this application, you will need Git installed on your computer.

$ git clone https://github.com/disias/reactnd-project-readable-starter.git

2. Run "npm install" in your local repository's folder

To get started developing right away:

  • Install and start the API server
    • $ cd api-server
    • $ npm install or $ yarn install
  • In another terminal window start front-end
    • $ cd frontend
    • $ npm install or $ yarn install

3. Start the app with "npm start"

To begin the React server and run the application:

$ npm start or $ yarn start

4. Open your browser at http://localhost:3000/

This is what the app should look like, once you open it in your browser.

posts

detail

Resources and Documentation:

Udacity Resources:

This project is licensed under the terms of the MIT license.

Information about the API server and how to use it can be found in its README file.