Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yuzakki committed Feb 14, 2024
1 parent 893aa55 commit 22d22a6
Show file tree
Hide file tree
Showing 8 changed files with 26 additions and 25 deletions.
51 changes: 26 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,34 @@
Next Project: Social Media Platform
# Friends: Social Media Platform

# Tech:
A responsive and accessible full stack social media web app.

- Mern Stack (React, NodeJS, Express, MongoDB)
- Build with NEXTJS latest Version [Typescript]
### Preview

# Tools & Libs:
![Screenshot](./public/design/preview.png)
![Screenshot](./public/design/5.png)
![Screenshot](./public/design/1.png)
![Screenshot](./public/design/4.png)
![Screenshot](./public/design/6.png)

- zod
- react hook form
### Features:

# Features:
- ✅ Login / Sign Up
- ✅ Manage Profile: Users can update their info, profile photo and cover photo
- ✅ Feeds Managment: Create, update and delete posts
- ✅ Like and unlike posts
- ✅ News Feed: display latest posts from users on home page
- ✅ Followers System: Follow and unfollow other users
- ✅ Responsive design

- Login / Sign Up ✅
- User Profile ✅
- Manage User Profile (create and customize profile, include pictures, cover photo, bio section) ✅
- News Feed (display latest posts from users in home page) ✅
- Post Creation (enable user to create post with: text, images, links..) ✅
- Show Suggested Users (show suggested users to follow) ✅
- Responsive Design ✅
> [!NOTE]
> This project is a work in progress. It includes upcoming features that have not been uploaded yet, and it will be regularly updated to incorporate all upcoming features.
- Dark / Light Mode
- Followers System (follow / unfollow / following list on user profile)
- Notifications (notify users about new followers, likes, comments)
- Real-Time Updates (implement real-time updates for notifications, news feed and messages using techs like webSocket)
- Messaging System (create private messaging system for users to send direct messages to their followers)
- Search Functionality (implement a search feature to find users)
### Tech Stack:

# Styling:

- TailwindCSS
- Shadcn
- TypeScript
- Nextjs latest (14)
- Tailwind CSS and shadcn UI
- Uploadthing
- React Hook Form
- Zod
- Server Actions
Binary file added public/design/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/design/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/design/3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/design/4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/design/5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/design/6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/design/preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 22d22a6

Please sign in to comment.