Simple React Social Network
Clone or download
Qolzam Merge pull request #101 from codacy-badger/codacy-badge
Add a Codacy badge to README.md
Latest commit 48a86a5 Oct 8, 2018
Permalink
Failed to load latest commit information.
.github Update issue templates Sep 24, 2018
docs Update README.md Sep 28, 2018
public [New Feature] Add more fields for edit profile Feb 25, 2018
src [feature] Chinese language Aug 17, 2018
.firebaserc [Improvement] handle close snackbar Feb 4, 2018
.gitignore [Improvement] Move to create-react-app (#17, #15) Feb 4, 2018
.snyk fix: .snyk & package.json to reduce vulnerabilities Jul 19, 2018
CHANGELOG.md [Change Log] v0.6.0 Mar 25, 2018
CODE_OF_CONDUCT.md Change code of conduct location Jul 8, 2017
CONTRIBUTING.md Edit contributing Jul 23, 2017
LICENSE [Update License] Jan 14, 2018
PULL_REQUEST_TEMPLATE.md Create PULL_REQUEST_TEMPLATE.md Sep 24, 2018
README.cn.md Update README.cn.md Sep 28, 2018
README.md Add Codacy badge Oct 8, 2018
_config.yml Repair markdown error Jul 8, 2017
book.json Change book config Jul 23, 2017
codecov.yml Update codecov.yml Oct 7, 2018
firebase.json [Resolved] build on home page & css import. Apr 16, 2018
package-lock.json All from #60 Jun 29, 2018
package.json fix: .snyk & package.json to reduce vulnerabilities Jul 19, 2018
server.js Add OAuth Login facebook,google,github Nov 18, 2017
tsconfig.json [Improvement] Move to create-react-app (#17, #15) Feb 4, 2018
tsconfig.prod.json [Resolved] [Security] Environment file is visible in both production … Aug 3, 2018
tslint.json Fixed unnecessary semicolon error Jun 29, 2018
yarn.lock [Resolved] [Security] Environment file is visible in both production … Aug 3, 2018

README.md

React Social Network 🚀 Version NEXT! 🚀

Codacy Badge Gitter
中文
The React Social Network is an open source project relying on React a powerful javascript library for building the user interface. In this project, I tried to show some features of react/react components as a social network. The structure of this project give the ability to developer to develop their project on their own idea and environment.

🌟New Upgrade :

React Social Network is moving on redux-saga however we keep redux-thunk version of React Social Network in branch name v0.5. Any contribution would be greatly appreciated by ❤️.

You should consult the CHANGELOG and related issues for more information

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to amir.gholzam@live.com.

Before Starting

First of all this is a boilerplate react social and the purpose is to find the best way to implement a huge project such as social network by React . We learn what technology or algorithm could be better solution for our project by React. Please approach to this project with these ideas and if you feel that you have better solution, to our great pleasure if we could have your contribution.

Example

Love Open Social

Required Knowledge

I recommend that you get to know React before using React Social Network. React Social Network has built by React components, so understanding how React fits into web development is important.

(If you're not familiar with the concept of Single Page Applications (SPAs), head over to the here for a quick introduction before you read on.

Document

Comming soon :) ...

Roadmap

Supporting diverse data platforms

Platform Accessible
Firebase/Firestore 👍
Amazon Web Service (AWS) On Developing ⚡️
Azure Future Support ⭐️
ASP.NET Core On Developing ⚡️

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Install NodeJs

Note

  • If you're using Windows you should install all node-gyp dependencies with following commands:

$ npm install --global --production windows-build-tools and then install the package

$ npm install --global node-gyp

Installing

You also have this blog which explain installation in details and for all level.

  1. Fork the react-social-network repository on Github
  2. Clone your fork to your local machine
    git clone git@github.com:<yourname>/react-social-network.git
  3. Go to the project root directory
    cd react-social-network
  4. To install node dependencies use
npm install

OR

yarn install
  1. Choose and install your backend before installing UI. React Network is able to be connected with every backend. Here we are developing some and you should choose one.

    Firestore Video tutorial

    Install React Social Network

    With Firestore

    With AWS

    • Coming soon ...

    With ASP.NET

    • Coming soon ...
  2. Go ahead ;)

    npm start

What is new? 🌟

Structure

New structure could make the project easy to change and scale up. There are three main layers:

IOC Container

  • Using InversifyJS in project give us the ability to switch between custom dependencies easily. Specially for data layer, if you are the user working with AWS you only need to call useAws() or using Firebase call useFirestore() in SocialEngine file.

Features

  • We moved from custom webpack to create-react-app.
  • Moving on redux-saga managing async request and side effects.
  • Supporting Async Component/Lazy loading for each container.
  • Support Localization by react-localize-redux. Providing this feature we support variety of languages. To contribute ❤️ your language you are able to add your local language. You only need to edit en.json from react-social-network root project and src/locale/en.json. You should name your file according ISO 639-1 Language Codes. For example for Spanish you should name es.json. Which es is the standard code of Spanish language.
  • InversifyJS as IOC container
  • Add auto compile on changing code for webpack
  • Open browser on after compiling on npm start. You need to set PORT=[PORT_NUMBER] in config file.
  • Add reset password, confirm password and authorizing by GitHub, Google and Facebook.
  • Add scroll auto loading for show posts and people pages.
  • Using Firestore
  • Supportig Right To Left
  • Some cool stuff :)

Can I connect React Social Network to other data platforms ? :bowtie:

Your server side is on PHP, Java,ASP.NET, Python, etc. Or you are using serverless platforms such as Google Cloud, AWS, Azure, etc. You can connect React Social Network to any data platform. You only need to implement the interfaces of core services like implementation of firestoreClient.

There are a summary steps of creating your own dataClients. We assume that we want to implement for PHP backend.

  • You need to know about TypeScript and implementing interfaces which I recommend take a look at this article.

  • You can get help from other dataClient implementation for your backend algorithm and also using core domain for the backend domain could be helpful.

  1. Create a folder in data layer name phpClient.
  2. Create a folder in /phpClient folder name services then in services folder create some folders following core/services folder such as services/votes, services/posts and etc.
  3. In each folder inside /phpClient/services/* folder you should implement following interfaces in core/services/* folder in file with appropriate name. For example we need to implement IPostService from core/services/posts/IPostService.ts in data/phpClient/services/posts/PostService.ts file.
  4. After implementing interfaces for services layer. We should register the dependencies for our phpClient services. Create a file in phpClient folder name dependecyRegisterar.ts.
  5. Following firestoreClient dependencies, add a function name usePhp() and bind dependencies in the the function. For example for PostService class add container.bind<IPostService>(SocialProviderTypes.PostService).to(PostService). Here SocialProviderTypes has the identifier of each service. To learn more take a look at inversify docs.
  6. Finally call registering dependencies function for in socialEngine file.
  7. Enjoy ;)

😍 It also would be great if you could contribute your clientData and backend with us to be part of this contribution. We would appreciate any conntribution.👍

Deployment

  • In command line of [react-social-network] root project, type firebase login. This command connects your local machine to your Firebase account and grants access to your projects. To test that authentication worked, you can run firebase list to see a list of all of your Firebase projects. The list should be the same as the projects listed at Firebase console.
  • Be sure the name of firebase project for [react-social-network] and this project is same. You also need to check .firebaserc if you set correct project name in default field of projects field.
    npm run deploy:firebase
  • Please checkout here for more deployment solution.

Built With

  • TypeScript TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
  • JSX/TSX This project support both *.jsx and *.tsx files. JSX is a statically-typed, object-oriented programming language designed to run on modern web browsers. Being developed at DeNA as a research project, the language has following characteristics.
  • React A javascript library for building user interfaces.
  • Redux is a predictable state container for JavaScript apps.
  • Material-UI A Set of React Components that Implement Google's Material Design.
  • react-redux Official React bindings for Redux.
  • Firebase products like Analytics, Realtime Database, Messaging, and Crash Reporting let you move quickly and focus on your users.
  • redux-saga is a library that aims to make application side effects (i.e. asynchronous things like data fetching and impure things like accessing the browser cache) easier to manage, more efficient to execute, simple to test, and better at handling failures.
  • redux-thunk Redux Thunk middleware allows you to write action creators that return a function instead of an action. The thunk can be used to delay the dispatch of an action, or to dispatch only if a certain condition is met. The inner function receives the store methods dispatch and getState as parameters.
  • React Router V4 for routing website location
  • Sass CSS with superpowers. Sass boasts more features and abilities than any other CSS extension language out there.
  • InversifyJS InversifyJS is a lightweight (4KB) inversion of control (IoC) container for TypeScript and JavaScript apps. A IoC container uses a class constructor to identify and inject its dependencies.
  • create-react-app Create React App is a tool built by developers at Facebook to help you build React applications. It saves you from time-consuming setup and configuration. You simply run one command and create react app sets up the tools you need to start your React project.

❤️ Contributing ❤️

React Social Network has been made by love❤️. I planed to build a back-end for this project and improve the performance as I process all procedures on the front-end side. If you'd like to help, check out the document. I'd greatly appreciate any contribution

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Amir Movahedi
  • See also the list of contributors who participated in this project.

How To Support

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

  • React
  • Firebase
  • JavaScript
  • TypeScript