[Readme] Update
This commit is contained in:
@@ -73,6 +73,8 @@ and then install the package
|
|||||||
2. Clone your fork to your local machine `git clone git@github.com:<yourname>/react-social-network.git`
|
2. Clone your fork to your local machine `git clone git@github.com:<yourname>/react-social-network.git`
|
||||||
|
|
||||||
3. Choose and install your backend bfore installing UI
|
3. Choose and install your backend bfore installing UI
|
||||||
|
|
||||||
|
[](firebase.google.com/cloud/firestore)
|
||||||
#### [Firestore Social Backend](https://github.com/Qolzam/firestore-social-backend)
|
#### [Firestore Social Backend](https://github.com/Qolzam/firestore-social-backend)
|
||||||
* Configure firebase:
|
* Configure firebase:
|
||||||
* Get [firebase config](https://firebase.google.com/docs/web/setup)
|
* Get [firebase config](https://firebase.google.com/docs/web/setup)
|
||||||
@@ -82,8 +84,18 @@ and then install the package
|
|||||||
* [Enable Email/Password](https://firebase.google.com/docs/auth/web/password-auth) sign-in on firebase:
|
* [Enable Email/Password](https://firebase.google.com/docs/auth/web/password-auth) sign-in on firebase:
|
||||||
* In the Firebase console, open the Auth section.
|
* In the Firebase console, open the Auth section.
|
||||||
* On the Sign in method tab, enable the Email/password sign-in method and click Save.
|
* On the Sign in method tab, enable the Email/password sign-in method and click Save.
|
||||||
|
* [Enable Firestore](https://firebase.google.com/docs/firestore/quickstart)
|
||||||
|
* Open the [Firebase Console](https://console.firebase.google.com/) and create a new project.
|
||||||
|
* In the Database section, click Try Firestore Beta.
|
||||||
|
* Click Enable.
|
||||||
|
* [Install Firestore Social Backend](https://github.com/Qolzam/firestore-social-backend)
|
||||||
|
* Enable firestore dependecies
|
||||||
|
* Go to React Social Network folder in `src/socialEngine.ts` write `useFirestore(provider)` to enable firestore dependencies!
|
||||||
|
|
||||||
#### AWS Social Backend
|
#### AWS Social Backend
|
||||||
|
* Comming soon ...
|
||||||
#### [ASP.NET Social Backend](https://github.com/Qolzam/aspnet-core-social-network)
|
#### [ASP.NET Social Backend](https://github.com/Qolzam/aspnet-core-social-network)
|
||||||
|
* Comming soon ...
|
||||||
|
|
||||||
4. Installing all nodejs modules:
|
4. Installing all nodejs modules:
|
||||||
`npm install`
|
`npm install`
|
||||||
|
|||||||
BIN
docs/app/firestore.png
Normal file
BIN
docs/app/firestore.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
@@ -4,7 +4,7 @@ This layer is responsible for implementing actions for entities. [Actions](http:
|
|||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
## authorizeActions.jsx
|
## authorizeActions
|
||||||
|
|
||||||
We provide some actions to authorize a user. The authorize actions include singup, login, logout and update password for a user.
|
We provide some actions to authorize a user. The authorize actions include singup, login, logout and update password for a user.
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ updatePassword = () => {}
|
|||||||
|
|
||||||
This action is responsible to fire reducer method on update password.
|
This action is responsible to fire reducer method on update password.
|
||||||
|
|
||||||
## circleActions.jsx
|
## circleActions
|
||||||
|
|
||||||
We provide some actions to authorize a user. The authorize actions include singup, login, logout and update password for a user.
|
We provide some actions to authorize a user. The authorize actions include singup, login, logout and update password for a user.
|
||||||
|
|
||||||
@@ -156,7 +156,7 @@ deleteFollowingUser = (uid, cid, followingId) => {}
|
|||||||
Delete a user from a circle.
|
Delete a user from a circle.
|
||||||
Delete a user with `followingId` identifier from a circle with `cid` identifier belong to the user with `uid` identifier. `userCircle` is an object of user information which we want to delete from a circle.
|
Delete a user with `followingId` identifier from a circle with `cid` identifier belong to the user with `uid` identifier. `userCircle` is an object of user information which we want to delete from a circle.
|
||||||
|
|
||||||
## commentActions.jsx
|
## commentActions
|
||||||
|
|
||||||
### Comment Action Functions
|
### Comment Action Functions
|
||||||
|
|
||||||
@@ -226,7 +226,7 @@ closeCommentEditor = (comment) => {}
|
|||||||
|
|
||||||
Comment comment editor of a comment. `comment` include comment information.
|
Comment comment editor of a comment. `comment` include comment information.
|
||||||
|
|
||||||
## globalActions.jsx
|
## globalActions
|
||||||
|
|
||||||
### Global Action Functions
|
### Global Action Functions
|
||||||
|
|
||||||
@@ -320,22 +320,22 @@ loadDataGuest = () => {}
|
|||||||
|
|
||||||
Execute some procedure like load essential data the time user is unauthorized.
|
Execute some procedure like load essential data the time user is unauthorized.
|
||||||
|
|
||||||
## imageGalleryActions.jsx
|
## imageGalleryActions
|
||||||
|
|
||||||
### Image Gallery Action Functions
|
### Image Gallery Action Functions
|
||||||
|
|
||||||
## notifyActions.jsx
|
## notifyActions
|
||||||
|
|
||||||
### Notify Action Functions
|
### Notify Action Functions
|
||||||
|
|
||||||
## postActions.jsx
|
## postActions
|
||||||
|
|
||||||
### Post Action Functions
|
### Post Action Functions
|
||||||
|
|
||||||
## userActions.jsx
|
## userActions
|
||||||
|
|
||||||
### User Action Functions
|
### User Action Functions
|
||||||
|
|
||||||
## voteActions.jsx
|
## voteActions
|
||||||
|
|
||||||
### Vote Action Functions
|
### Vote Action Functions
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Is a decoupled layer of interfaces to data and/or functionality of one or more components.
|
Is a decoupled layer of interfaces to data and/or functionality of one or more components.
|
||||||
|
|
||||||
## FileAPI.jsx
|
## FileAPI
|
||||||
|
|
||||||
A set of functions for working with files.
|
A set of functions for working with files.
|
||||||
|
|
||||||
@@ -30,7 +30,7 @@ dataURLToBlob = (dataURL) => {}
|
|||||||
|
|
||||||
Convert [data url file](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) to [blob file](https://developer.mozilla.org/en/docs/Web/API/Blob). `dataURL` is the file with data url type.
|
Convert [data url file](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) to [blob file](https://developer.mozilla.org/en/docs/Web/API/Blob). `dataURL` is the file with data url type.
|
||||||
|
|
||||||
## PostAPI.jsx
|
## PostAPI
|
||||||
|
|
||||||
A set of functions for working with user posts.
|
A set of functions for working with user posts.
|
||||||
|
|
||||||
|
|||||||
@@ -2,6 +2,6 @@
|
|||||||
|
|
||||||
App layer is included whole main application libraries and components.
|
App layer is included whole main application libraries and components.
|
||||||
|
|
||||||
## app.jsx
|
## app
|
||||||
|
|
||||||
The root component that is responsible for rendering the whole React DOM on the browser and connecting components to redux [store](http://redux.js.org/docs/api/Store.html).
|
The root component that is responsible for rendering the whole React DOM on the browser and connecting components to redux [store](http://redux.js.org/docs/api/Store.html).
|
||||||
@@ -4,9 +4,9 @@ This layer include [React components](https://facebook.github.io/react/docs/reac
|
|||||||
|
|
||||||
## Add a new component
|
## Add a new component
|
||||||
|
|
||||||
To add a new page in Home.jsx (with side-bar and top-bar) :
|
To add a new page in Home (with side-bar and top-bar) :
|
||||||
|
|
||||||
- In components/Home.jsx
|
- In components/Home
|
||||||
- Inside the [Switch] tag
|
- Inside the [Switch] tag
|
||||||
|
|
||||||
```jsx
|
```jsx
|
||||||
@@ -25,7 +25,7 @@ To add a new page in Home.jsx (with side-bar and top-bar) :
|
|||||||
|
|
||||||
To add a new item for menu bar
|
To add a new item for menu bar
|
||||||
|
|
||||||
- In components/Home.jsx
|
- In components/Home
|
||||||
- Inside the [Menu] tag
|
- Inside the [Menu] tag
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
|
|||||||
@@ -2,46 +2,46 @@
|
|||||||
|
|
||||||
This layer is included reducers of entities. [Reducers](http://redux.js.org/docs/basics/Reducers.html) specify how the application's state changes in response.
|
This layer is included reducers of entities. [Reducers](http://redux.js.org/docs/basics/Reducers.html) specify how the application's state changes in response.
|
||||||
|
|
||||||
## authorizeReducer.jsx
|
## authorizeReducer
|
||||||
|
|
||||||
This reducer is responsible to change user authorization state on reducer.
|
This reducer is responsible to change user authorization state on reducer.
|
||||||
|
|
||||||
## circleReducer.jsx
|
## circleReducer
|
||||||
|
|
||||||
This reducer is responsible to change user's circle state on reducer, insert/update/delete circle and insert/update/delete follower/following.
|
This reducer is responsible to change user's circle state on reducer, insert/update/delete circle and insert/update/delete follower/following.
|
||||||
|
|
||||||
## commentReducer.jsx
|
## commentReducer
|
||||||
|
|
||||||
This reducer is responsible to change user comment state on reducer, insert/update/delete comment.
|
This reducer is responsible to change user comment state on reducer, insert/update/delete comment.
|
||||||
|
|
||||||
## fileReducer.jsx
|
## fileReducer
|
||||||
|
|
||||||
This reducer is responsible to change files state on reducer.
|
This reducer is responsible to change files state on reducer.
|
||||||
|
|
||||||
## globalReducer.jsx
|
## globalReducer
|
||||||
|
|
||||||
This reducer is responsible to change global states on reducer. Like changing loding visibility or notification text.
|
This reducer is responsible to change global states on reducer. Like changing loding visibility or notification text.
|
||||||
|
|
||||||
## imageGalleryReducer.jsx
|
## imageGalleryReducer
|
||||||
|
|
||||||
This reducer is responsible to change images state on reducer, insert/update/delete image and cache image's url.
|
This reducer is responsible to change images state on reducer, insert/update/delete image and cache image's url.
|
||||||
|
|
||||||
## imageUploaderReducer.jsx
|
## imageUploaderReducer
|
||||||
|
|
||||||
This reducer is responsible to change user upload state on reducer.
|
This reducer is responsible to change user upload state on reducer.
|
||||||
|
|
||||||
## notifyReducer.jsx
|
## notifyReducer
|
||||||
|
|
||||||
This reducer is responsible to change user notification state on reducer, insert/update/delete notificaion and change seen state for notification.
|
This reducer is responsible to change user notification state on reducer, insert/update/delete notificaion and change seen state for notification.
|
||||||
|
|
||||||
## postReducer.jsx
|
## postReducer
|
||||||
|
|
||||||
This reducer is responsible to change user post state on reducer, insert/update/delete post.
|
This reducer is responsible to change user post state on reducer, insert/update/delete post.
|
||||||
|
|
||||||
## userReducer.jsx
|
## userReducer
|
||||||
|
|
||||||
This reducer is responsible to change user information state on reducer, insert/update/delete user information.
|
This reducer is responsible to change user information state on reducer, insert/update/delete user information.
|
||||||
|
|
||||||
## voteReducer.jsx
|
## voteReducer
|
||||||
|
|
||||||
This reducer is responsible to change user vote state on reducer. insert/update/delete vote.
|
This reducer is responsible to change user vote state on reducer. insert/update/delete vote.
|
||||||
Reference in New Issue
Block a user