Giter Club home page Giter Club logo

reactnd-project-readable's Introduction

Talk About React

"Talk About React - Student Discussion Board" is a reddit style discussion forum web app, for Udacity’s React Nanodegree second project assignment, "Readable". Users will be able to post content to predefined categories, comment on their posts and other users' posts, and vote on posts and comments. Also, users will also be able to edit and delete posts and comments.

  • This app was built with react, redux, react-redux-router, redux-thunk, material-ui.

  • Most application state(Create, Read, Edit, Delete, Voting posts/comments) is managed by the Redux store. Updates are triggered by dispatching actions to reducers.

Table of contents

Demo

screencast

Live Demo : TBD

For a demo, check out https://reactnd-readable.firebaseapp.com/

Quick Start

Run React App (Frontend)

  • Clone project locally git clone https://github.com/sujinleeme/reactnd-project-readable.git.
  • Go to react app cd readable.
  • Install all project dependencies with npm install in readable folder.
  • Run server with npm start.
  • Check console or browser if server runs on http://localhost:3000/.

Run local backend development server (Node)

To install and start the API server, run the following commands in api-server directory:

  • Go to Server Directory cd readable/src/api-server.
  • Install all server dependencies with npm install.
  • Run backend server with node server.js.
  • Check console or browser if server runs on http://localhost:3001/.

To build & deploy on firebase:

npm run build && npm run deploy

Documentation

What's included

Within the download you'll find the following directories and files in src:

|-- api-server
|   |-- README.md
|   |-- categories.js
|   |-- comments.js
|   |-- config.js
|   |-- package.json
|   |-- posts.js
|   |-- server.js
|   `-- tabs.js
|-- components
|   |-- assets
|   |   |-- GithubIcon.js
|   |   `-- LoadingProgress.js
|   |-- footer
|   |   `-- CopyrightBar.js
|   |-- header
|   |   `-- HeaderBar.js
|   |-- menu
|   |   |-- CategoryContainer.js
|   |   `-- TabContainer.js
|   |-- pages
|   |   |-- AllPostsPage.js
|   |   |-- CategoryPostsPage.js
|   |   |-- MainRouterSettingLayoutPage.js
|   |   |-- NotFound.js
|   |   |-- PostDetailComments.js
|   |   `-- PostDetailPage.js
|   `-- post
|       |-- body
|       |   `-- PostContent.js
|       |-- buttons
|       |   |-- CommentButton.js
|       |   |-- PostSaveCancelButton.js
|       |   |-- PostSettingButton.js
|       |   `-- UpDownVoter.js
|       |-- create
|       |   |-- NewComment.js
|       |   `-- NewPost.js
|       `-- list
|           |-- PostCard.js
|           `-- PostListContainer.js
|-- history.js
|-- index.css
|-- index.js
|-- modules
|   |-- actionTypes
|   |   |-- menuTypes.js
|   |   `-- postsTypes.js
|   |-- actions
|   |   |-- menu.js
|   |   `-- posts.js
|   |-- reducers
|   |   |-- menu.js
|   |   `-- posts.js
|   `-- root
|       |-- configStore
|       |   `-- index.js
|       |-- configurl.js
|       |-- headers.js
|       `-- rootReducer
|           `-- index.js
|-- registerServiceWorker.js
|-- store.js
|-- styles
|   |-- CustomTheme.js
|   |-- assets
|   |   `-- LoadingProgress.js
|   |-- buttons
|   |   |-- CommentButton.js
|   |   |-- PostSaveCancelButton.js
|   |   `-- UpDownVoter.js
|   |-- footer
|   |   `-- CopyrightBar.js
|   |-- form
|   |   |-- NewComment.js
|   |   `-- NewPost.js
|   |-- header
|   |   `-- HeaderBar.js
|   |-- menu
|   |   |-- CategoryContainer.js
|   |   `-- TabContainer.js
|   |-- page
|   |   |-- MainRouterSettingLayoutPage.js
|   |   |-- NotFound.js
|   |   `-- PostDetailPage.js
|   `-- post
|       |-- PostCard.js
|       |-- PostContent.js
|       `-- PostListContainer.js
`-- utils
    `-- utils.js

TBD

  • Use Firebase for backend.

Copyright and License

reactnd-project-readable's People

Contributors

sujinleeme avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  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.