Skip to content

Commit

Permalink
docs: readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
manismk committed May 24, 2022
1 parent 4ac38b4 commit 9eef71b
Showing 1 changed file with 26 additions and 7 deletions.
33 changes: 26 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Socialoo - Engage and Entertain

**Socialoo is social media platform to share your thoughts, feelings and engage with them. Connect with people and get entertained.**

**Take a look at [Socialoo](https://socialoo.netlify.app/)**
Expand All @@ -8,6 +9,7 @@
---

## Table of Contents

1. [Features](#Features)
2. [Run Locally](#run-locally)
3. [Todo](#todo)
Expand All @@ -19,66 +21,82 @@

## Features

**Login**
**Login**

- User able to login by entering email and password
- User can use guest credentials to login
- Form validation is done for login fields
- Logged in user only can access the app

**Sign Up**

- User able to create account and signup for the site
- Form validation is done for signup fields

**Home Page**

- Home page has the posts of the user who you follow
- It also has suggestion card to other user you can follow

**Explore page**

- Explore page shows the posts by all the user
- It also has suggestion card to other user you can follow

**Create Post**

- User can click create post button and an Form will appear in the modal
- Where they can give the caption and chose image for a post
- User can post a text post or image post

**Edit Post**

- User can click edit button on users's post to edit the particular post posted by the user.
- User can edit the text and image in the modal.

**Like Feature**

- User can like/unlike like the post from post card

**Follow Feature**

- User can follow/ unfollow a user from post card or suggestsion card.

**Save Feature**

- User can add/remove a post from save in post card
- Saved page shows all the saved posts and option to remnove it from page.
- Saved page shows all the saved posts and option to remnove it from page.

**Comment Feature**

- When the user click the comment button from post card it will open the single post page.
- Single post page have feature to comment.
- User can also reply to existing comments.

**Share Feature**

- When the share button in post card is clicked link to that particular post is copied to clipboard and the user can share them.

**Single Post Page**

- Single Post page has the post with the comments of the post.

**Profile page**

- User profile page with Name, Followers, Following, Bio and portfolio link.
- Option to Edit the profile details like name, bio and portfolio link.
- Button to logout from the app.

**Private Routes**

- All the user specific routes are made as private routes and can be accessed only after login

**Loaders and Toasts**

- Loaders and toast is provided as the acknowledgment to the users

**Backend**

- Backend is done with the help of firebase

---
Expand All @@ -89,7 +107,7 @@
$ git clone https://github.com/manismk/socialoo.git
$ cd socialoo
$ npm install
$ npm start
$ npm start
```

---
Expand Down Expand Up @@ -118,9 +136,11 @@ Resources that help in building Finflix includes
4. [Fastart component library](https://fastart.netlify.app/)
5. [Google Fonts](https://fonts.google.com/)
6. [Material Icons](https://mui.com/components/material-icons/)
8. [React toastify](https://fkhadra.github.io/react-toastify/introduction)
9. [Moment js](https://momentjs.com/)
11. [React drag and drop files](https://github.com/KarimMokhtar/react-drag-drop-files)
7. [React toastify](https://fkhadra.github.io/react-toastify/introduction)
8. [Moment js](https://momentjs.com/)
9. [React drag and drop files](https://github.com/KarimMokhtar/react-drag-drop-files)
10. [Redux toolkit](https://redux-toolkit.js.org/)
11. [React redux](https://react-redux.js.org/)

---

Expand All @@ -129,4 +149,3 @@ Resources that help in building Finflix includes
- [Manikandan](https://manikandan.netlify.app/)
- [Twitter](https://twitter.com/_manismk)
- [Linkedin](https://www.linkedin.com/in/manismk/)

0 comments on commit 9eef71b

Please sign in to comment.