A web-based Social Media Platform that connects users, enables content sharing, and facilitates engagement with others.
- User registration and authentication
- Profile creation and editing
- Content posting (text, images, videos)
- Interacting with posts (likes, comments, shares)
- Friend requests and connections
- Notifications for interactions
- Privacy settings customization
- User and content search
- Reporting inappropriate content
Before you begin, ensure you have met the following requirements:
- Node.js: Install the latest version of Node.js from nodejs.org.
- npm: Make sure you have npm (Node Package Manager) installed. It usually comes with Node.js.
- MongoDB: You need a MongoDB database to store user profiles, posts, and interactions. Install and configure MongoDB from mongodb.com.
- Express.js: This project uses Express.js for building the backend API. Familiarity with Express.js will be helpful.
- React: The frontend of the platform is built using React. Install it using
npm install -g create-react-app. - Basic HTML/CSS: Understanding of basic HTML and CSS is required for styling and layout adjustments.
- Email Service: For sending verification emails, you'll need an email service provider like SendGrid or Mailgun.
- Cloud Hosting: To deploy the application, consider services like Heroku, Netlify, or AWS.
- Git: Version control system. Install Git from git-scm.com.
- Code Editor: A code editor such as Visual Studio Code or Sublime Text.
Follow these steps to get the Social Media Platform up and running on your local machine.
Before you begin, make sure you have the following prerequisites installed:
- Node.js: Install the latest version of Node.js, which includes npm (Node Package Manager).
- MongoDB: Set up and configure a MongoDB database to store user data and content.
git clone https://github.com/yourusername/social-media-platform.git
cd social-media-platformOnce you have the Social Media Platform up and running, you can start exploring its features. Here's a guide to using the platform effectively:
- Open your web browser and go to
http://localhost:3000. - Click on the "Sign Up" link to create a new account.
- Fill in the required information, including your email and password.
- After registering, you'll receive a verification email. Click the link to activate your account.
- Once your account is verified, log in using your registered email and password.
- After logging in, click on your profile picture or username to access your profile.
- Click on the "Edit Profile" button to update your profile information and profile picture.
- On the home page, you'll see a "Create Post" button. Click on it.
- Choose whether to post text, images, or videos.
- Write your post's content or upload the media file.
- Add relevant tags and click "Post" to share your content with others.
- On any post, you can click the "Like" button to show appreciation for the content.
- Leave a comment by typing in the comment box and pressing "Enter."
- Use the "Share" button to repost the content to your own profile.
- Search for other users using the search bar or browse through the user list.
- Click on a user's profile to view their details.
- Send a friend request to connect with other users.
- Accept incoming friend requests from the notifications section.
- Notifications will appear in the bell icon at the top of the page.
- You'll receive notifications for friend requests, likes, comments, and shares.
- Manage your privacy settings by clicking on "Privacy" in your profile settings.
- Adjust who can see your posts and profile information.
- Use the search bar to find other users by their usernames or keywords.
- Discover new content by searching for specific tags.
- If you come across inappropriate content, use the "Report" option on the post or comment.
- Admins will review and take appropriate action.
Explore these features to experience the full potential of the Social Media Platform. If you encounter any issues or have questions, refer to the Contributing section for support.
We welcome contributions from the community! If you'd like to contribute to the Social Media Platform project, follow these steps:
-
Fork the Repository: Click the "Fork" button at the top right corner of the repository. This will create a copy of the project in your GitHub account.
-
Clone Your Fork: Clone the forked repository to your local machine:
git clone https://github.com/yourusername/social-media-platform.git cd social-media-platform
This project is licensed under the MIT License - see the LICENSE file for details.
Note: The license primarily applies to the project's source code. Images, icons, and other non-code assets may have different licenses. Please review individual asset licenses in the respective directories.