diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6bac675 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +.vscode/ +node_modules/ +**/node_modules/ +.DS_Store +npm-debug.log* +yarn-debug.log* +yarn-error.log* +/.changelog \ No newline at end of file diff --git a/README.md b/README.md index 0fd5bea..e328d57 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -#Readable (React - Redux) +# Readable (React - Redux) Udacity Nanodegree Project on React and Redux, Readable is a content and comment web app. Users can 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. @@ -6,7 +6,9 @@ This project was bootstrapped with [Create React App](https://github.com/faceboo To run locally: -- Clone this repository https://github.com/smarajitdasgupta/reactnd-readable +- Clone this repository https://github.com/smarajitdasgupta/readable-react + +## API server * Install and start the Backend REST API Server - `cd api-server` @@ -15,545 +17,13 @@ To run locally: The server will listen on port 3001 by default +Information about the API server and how to use it can be found in its [README file](api-server/README.md). + +## Front end code + * In another terminal window, run the front-end code - `cd reactnd-readable-frontend` - `npm install` - `npm start` The React app will run on http://localhost:3000/ by default - -Information about the API server and how to use it can be found in its [README file](api-server/README.md). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -