diff --git a/README.md b/README.md index 127d68c..bb56d42 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/public/design/1.png b/public/design/1.png new file mode 100644 index 0000000..01756cc Binary files /dev/null and b/public/design/1.png differ diff --git a/public/design/2.png b/public/design/2.png new file mode 100644 index 0000000..cff44f1 Binary files /dev/null and b/public/design/2.png differ diff --git a/public/design/3.png b/public/design/3.png new file mode 100644 index 0000000..69761f1 Binary files /dev/null and b/public/design/3.png differ diff --git a/public/design/4.png b/public/design/4.png new file mode 100644 index 0000000..6f639b9 Binary files /dev/null and b/public/design/4.png differ diff --git a/public/design/5.png b/public/design/5.png new file mode 100644 index 0000000..dc3661b Binary files /dev/null and b/public/design/5.png differ diff --git a/public/design/6.png b/public/design/6.png new file mode 100644 index 0000000..0d3ca76 Binary files /dev/null and b/public/design/6.png differ diff --git a/public/design/preview.png b/public/design/preview.png new file mode 100644 index 0000000..9198856 Binary files /dev/null and b/public/design/preview.png differ