SoulDev - Welcome to SoulDev, the ultimate destination for developers to connect, collaborate, and innovate. Join our vibrant community to exchange ideas, share insights, and build together. Experience the power of unity in coding.
Welcome to the repository of our social media web application! This README provides an overview of the project, including the technologies used in both the frontend and backend, setup instructions, and contribution guidelines. This repository contains the source code for a social media web application. The application enables users to create profiles, share posts, interact in real-time, and more. It leverages modern web technologies to provide a seamless and responsive user experience.
Production has been deploy at url SoulDev
- Framework UI: NextJS 14
- UI Library: ReactJS
- Programming Languages: TypeScript, JavaScript
- Realtime Platform: Socket.io Client
- API Handling, Data Fetching: NextJS Server Actions, Axios, React Query
- Authentication & Authorization: NextAuth
- Source Version Control: Git, GitHub
- Programming Language: JavaScript
- Database: MongoDB, Redis
- Source Version Control: Git, GitLab
- Frameworks and Libraries:
- Express
- Cloudinary
- Socket.io
- Swagger
- and more...
- Server: Vercel
- CI/CD: GitLab CI/CD
- Cloud Services: AWS EC2
- Containerization: Docker, Docker Compose
- Notification Center: Novu
- Domain Hosting: Hostinger
-
News Feeds
- Real-time updates from friends and followed pages
- Personalized content based on user interests
- Ability to like, comment, and share posts
-
Groups
- Create and join groups based on interests
- Group-specific discussions and posts
- Admin and moderator roles for managing groups
-
Pages
- Create and manage pages for businesses, brands, or interests
- Post updates and interact with followers
- Analytics for page performance
-
Chatting
- Real-time messaging with friends and groups
- Support for text, images, videos, and file sharing
- Online status and typing indicators
-
Profile
- Customizable user profiles with bio, profile picture, and cover photo
- Timeline of user’s posts and activities
- Privacy settings for controlling profile visibility
-
Notifications
- Real-time notifications for likes, comments, shares, and messages
- Notification center for managing all alerts
- Customizable notification preferences
-
Search
- Advanced search functionality to find people, pages, and groups
- Filtered search results based on relevance and interests
-
Content Management
- Rich text editor for creating posts
- Media library for managing uploaded images and videos
- Drafts and scheduled posts
-
Dark Mode
- Toggle between light and dark themes
- Enhanced readability and reduced eye strain
Before you get started, you need to install the following prerequisites:
- Node.js - JavaScript runtime environment with v18 or higher.
- NodeJS package management like pnpm or Bun.
- MongoDB
- Redis
- Git
Once you have Node.js and bun (or pnpm) installed, you can proceed with the project setup:
- Clone the project from the remote repository:
# Clone on method HTTPS
git clone https://github.com/hoigreen/project-souldev.git
# Clone on method SSH
git clone git@github.com:hoigreen/project-souldev.git- Install project dependencies:
pnpm install
# or with Bun
bun install-
Setup file .env with your config project.
-
Starting client and server
bun devThe SoulDev application will run localy at address http://localhost:3000
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
If you have ideas for releases in the future, it is a good idea to list them in the README.
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
Show your appreciation to those who have contributed to the project.
For open source projects, say how it is licensed.
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
- Truong Quoc Hoi
- Huy Nguyen