Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/react-dev-james/mern-zwitter


https://github.com/react-dev-james/mern-zwitter

express front-end google-material mongodb nodejs reactjs redux

Last synced: about 8 hours ago
JSON representation

Awesome Lists containing this project

README 

        
# 🐣 Node Express/MongoDB + React/Redux App - Zwitter

A basic clone of Twitter (Boilerplate App) using - Node, Express, MongoDB, React and Redux using **create-react-app** with separate **API** `(express+mongo)` and **Frontend** `(react+redux)` folders. Uses Google's Material Design UI (`material-ui` package).



## 📝 Features

- [x] List all tweets

- [x] View single tweet

- [x] Post a tweet

- [x] Login / Register

- [x] Enable [CORS](https://enable-cors.org/index.html)

- [x] Progressive Web App features (Offline first, Service worker, Application shell)



## ▶️ Running

- Clone repo `git clone https://github.com/DedicatedWebStar/MERN-Zwitter`

- Install NPM modules for **api** `cd api` and `npm install`

- Install NPM modules for **frontend** `cd frontend` and `npm install`

- Run **api** server `cd api` and `npm start` (runs on port configured under `api/src/config/index.js`)

- Run **frontend** server `cd frontend` and `npm start` (runs on port 3000 or your `PORT` environment, should automatically open in your browser)



## 📦 Packages Used



### API

- **bcrypt** (Library to help you hash passwords)

- **body-parser** (Parse incoming request bodies)

- **cookie-parser** (Parse Cookie header)

- **express** (Fast, unopinionated, minimalist web framework)

- **jsonwebtoken** (JSON Web Token implementation)

- lodash (Modular utilities)

- moment (Parse, validate, manipulate, and display dates)

- **mongoose** (MongoDB object modeling tool)



### Frontend

- classnames (A simple utility for conditionally joining classNames together)

- **immutability-helper** (Mutate a copy of data without changing the original source)

- **material-ui** (React Components that Implement Google's Material Design)

- moment (Parse, validate, manipulate, and display dates)

- **react** (Library for building user interfaces)

- **react-addons-css-transition-group** (React CSSTransitionGroup add-on)

- **react-dom** (React package for working with the DOM)

- **react-redux** (Official React bindings for Redux)

- **react-router-dom** (v4, A complete routing library for React)

- **react-tap-event-plugin** (Facebook's TapEventPlugin)

- **redux** (Predictable state container for JavaScript apps)

- redux-devtools-extension (Redux DevTools extension)

- **redux-thunk** (Thunk middleware for Redux)

## 🏗 ScreenShort



![Screen](https://github.com/DedicatedWebStar/MERN-Zwitter/blob/master/screenshort.png?raw=true)



## 🏗 Core Structure

    zwitter

      ├── api (api.example.com)

      │   ├── src

      │   │   ├── config

      │   │   ├── models

      │   │   ├── routes

      │   │   ├── server.js

      │   │   └── index.js

      │   │

      │   └── package.json

      │

      ├── frontend (example.com)

      │   ├── public

      │   ├── src

      │   │   ├── actions

      │   │   ├── components

      │   │   ├── reducers

      │   │   ├── app.js

      │   │   └── index.js

      │   │

      │   └── package.json

      │

      ├── .gitignore

      └── README.md



## 🎩 Author

Atul Yadav - [GitHub](https://github.com/DedicatedWebStar)



## 📜 License

Copyright (c) 2017 DedicatedWebStar https://github.com/DedicatedWebStar



Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.