README.md

NonLegit

”Lets Go, Start New Adventure.⚡“

Table of Contents

• 📙 Overview
• 💻 Get Started
• 🌎 Build & deployment
• 🔍 Features
• 📽 GIF Demo
• ✨ Contributors
• 🔒 License

---

Overview

• NonLegit mimic some functionalities of Reddit
• We are responsible for Front-End part
• The project is built by
  1. React
  2. MUI
  3. Firebase
  4. eslint
  5. jest
• Project Description


• You can view Nonleghit

  Note: This deployment is built using json server

---

Get Started

1. Clone the repository
   

   git clone https://github.com/NonLegit/Front-End/tree/main
   

2. Run json server
   

   npm run server-json 
   

3. Run the program
   

   npm run start
   

4. Build functional document
   

   npm run docs
   

5. Build test document
   

   npm run test
   

---

Build & Deployment

There are a few additional environment variables that are used when building and deploying for production.

1. REACT_APP_GOOGLECLIENTID: A environment string used in connecting with google client.
2. REACT_APP_FACEBOOKCLIENTID:A environment string used in connecting with facebook client.
3. REACT_APP_SITEKEY: A environment string used in google captcha..
4. REACT_APP_ENV: An environment string. Currently it is only used to differentiate different deploys (development or production).
5. REACT_APP_PROXY_DEVELOPMENT: The base URL of the development server. default value is http://localhost:8000.
6. REACT_APP_PROXY_PRODUCTION: The base URL of the backend

---

Features

---

Feature	ScreenShot	Description
🔷 Authentication		Login Sign-up Sign-up with Google and Facebook Reset Password Forget User Name
🔶 Create Post		1) You con create 3 types of post 📝 Text: you can add text and styling it with fancy text editor 📷 Image: you can upload photo or video to add to your post 📎 Link: you can add link to your post 2) You con add 2 tag to your post 🔞 NSFW 💥 spoiler
🔷 Search		The search results have 4 types 📫 Posts 💭 Comments 👨‍👧 Communities 👨‍👨‍👦‍👦 People
🔶 User Actions		You con do actions on posts like ⏏ Upvote & Downvote ⤴ Share ✒ Edit post ✅ Approve (if you are moderator) 🕳 Spam 🙈 Hidden 🔱 Save 🚫 Delete (if you are moderator or creator post) 🔒 Lock (if you are moderator or creator post)
🔷 Comments		1) 🖇 Multilevel Comments 3) Actions on posts: ⏏ Upvote & Downvote ✅ Approve (if you are moderator) 🕳 Spam 🔱 Save 🗯 Replay
🔶 Settings		🚹 Account You can change (Email, Password, Gender, Country) Delete Account Connect with google 👤 Profile You can Edit (name , about, Profile picture, Background Picture) You can on/off (NSFW, allow people to follow you) You can add social links to other website 🚨 Safety and privacy 🔈 You can block and unblock user You can see block list ⚡ Feed Settings You can on/off (Adult content, autoplay media)
🔷 Notifications		1) 🙈 You con hide notification 2) Types Notification: New Followers Replies
🔶 Profile		You con view 🏔 Overview: you can see activity of user 📫 Posts: you can see posts of user 🗯 Comments: you can see comments of user 🗃 History: posts just yo see it 📋 Saved: posts and comments you saved it 🙈 Hidden: posts you hide it 👍 Upvote: posts you upvote it 👎 Downvote: posts you downvote it
🔷 Subreddit		1) 🔰 You con create Subreddit 2) 👀 View posts of Subreddit 3) 🤜🏼 join or leave Subreddit 4) Subreddit types: 👷🏼‍♂️ Public: Anyone can view, post, and comment to this community 👁‍🗨 Restricted: Anyone can view this community, but only approved users can post 🔒 Private: Only approved users can view and submit to this community
🔶 Moderation		In Moderation page, you can control: 🕳 Spam: you can control spam posts ✒ Edited: you can control edited posts 💈 Unmoderator: you can control unmoderator posts 🚫 BANNED: you can ban users 🔈 MUTED: you can mute users ✅ APPROVED: you can add new moderators 👨🏽‍🤝‍👨🏻 MODERATORS: you can edit access to moderators 🎨 POST FLAIR: you can edit flair and make new flairs 🚧 RULES: you can add new rules to subreddit 👨‍👨‍👦‍👦 COMMUNITY: you can edit (name of subreddit, community topics, community description, region, type of community) 💭 POSTS AND COMMENTS: you can control type of posts
🔷 Messages		1) 📩 Message Form (Send a private message) 2) 📮 Sent Messages: message which you sent 3) 📦 Inbox : All: All messages Unread: message which you didn't read it Messages : message which you receive Post replies: replies to your posts
🔶 Push Notifications		1) 💌 Notifications and messages 2) 🔓 You must give permission to push notifications 3) Push Notifications types: Foreground Background
🔷 Top Communities		👨‍👨‍👧‍👧 View top communities by categories
🔶 Pages		Home page Popular ALL Explorer
🔷 Listing		You can sort posts Hot Top New Hot

---

GIF Demo

Video	Content
NonLegit_1.mp4	Authentication Comments Notification Messages Settings

---

NonLegit_2.mp4

Home page Posts Create Post

---

NonLegit_3.mp4

My profile Other Profile Moderation Top Communities

---

NonLegit_4.mp4

Create Subreddit Subreddit Moderation Search Explorer

---

Contributors

Nour Ziad Almulhem

Basma Elhoseny

Fady Adel

Ahmed Hosny

Adham Ali

Eslam Ashraf

🔒 License

Note: This software is licensed under MIT License, See License for more information ©NonLegit.