Socialite

🌟 Welcome to Socialite - The Ultimate Social Connection Hub! 🌟

The community at Socialite is buzzing with excitement as new members join the platform. Users are invited to immerse themselves in a world where connections thrive, friendships flourish, and happiness knows no bounds.

📖 Table of Contents

📖 Table of Contents
📍 Overview
📦 Features
📂 Repository Structure
⚙️ Modules
🚀 Getting Started
🛣 Roadmap
🤝 Contributing
📄 License
👏 Acknowledgments

📍 Overview

Light Mode

Dark Mode

📦 Features

HTTPStatus Exception: 429

📂 Repository Structure

└── socialite/
    ├── .dockerignore
    ├── .github/
    │   └── workflows/
    ├── .gitignore
    ├── LICENSE
    ├── README.md
    ├── client/
    │   ├── .gitignore
    │   ├── Dockerfile
    │   ├── jsconfig.json
    │   ├── package.json
    │   ├── public/
    │   └── src/
    ├── docker-compose.yml
    ├── readme.md
    └── server/
        ├── .env
        ├── Dockerfile
        ├── controllers/
        ├── index.js
        ├── middleware/
        ├── models/
        ├── package.json
        ├── public/
        ├── routes/
        └── vercel.json

⚙️ Modules

Root

File	Summary
docker-compose.yml	HTTPStatus Exception: 429

Server

File	Summary
index.js	HTTPStatus Exception: 429
Dockerfile	HTTPStatus Exception: 429

Routes

File	Summary
users.js	HTTPStatus Exception: 429
posts.js	HTTPStatus Exception: 429
auth.js	HTTPStatus Exception: 429

Models

File	Summary
User.js	HTTPStatus Exception: 429
Post.js	HTTPStatus Exception: 429

Middleware

File	Summary
auth.js	HTTPStatus Exception: 429

Controllers

File	Summary
users.js	HTTPStatus Exception: 429
posts.js	HTTPStatus Exception: 429
auth.js	HTTPStatus Exception: 429

Client

File	Summary
Dockerfile	HTTPStatus Exception: 429

Src

File	Summary
theme.js	HTTPStatus Exception: 429
index.js	HTTPStatus Exception: 429
index.css	HTTPStatus Exception: 429
App.js	HTTPStatus Exception: 429

State

File	Summary
index.js	HTTPStatus Exception: 429

Widgets

File	Summary
UserWidget.jsx	HTTPStatus Exception: 429
PostsWidget.jsx	HTTPStatus Exception: 429
PostWidget.jsx	HTTPStatus Exception: 429
MyPostWidget.jsx	HTTPStatus Exception: 429
FriendListWidget.jsx	HTTPStatus Exception: 429
AdvertWidget.jsx	HTTPStatus Exception: 429

Profilepage

File	Summary
index.jsx	HTTPStatus Exception: 429

Navbar

File	Summary
index.jsx	HTTPStatus Exception: 429

Loginpage

File	Summary
index.jsx	HTTPStatus Exception: 429
Form.jsx	HTTPStatus Exception: 429

Homepage

File	Summary
index.jsx	HTTPStatus Exception: 429

Components

File	Summary
WidgetWrapper.jsx	HTTPStatus Exception: 429
UserImage.jsx	HTTPStatus Exception: 429
Friend.jsx	HTTPStatus Exception: 429
FlexBetween.jsx	HTTPStatus Exception: 429
CommentSection.jsx	HTTPStatus Exception: 429

Public

File	Summary
robots.txt	HTTPStatus Exception: 429
index.html	HTTPStatus Exception: 429

Workflows

File	Summary
webpack.yml	HTTPStatus Exception: 429

🚀 Getting Started

Dependencies

Please ensure you have the following dependencies installed on your system:

- ℹ️ NodeJs

🔧 Installation

Clone the socialite repository:

git clone https://github.com/arnab2001/socialite

Change to the project directory:

cd socialite

Install the dependencies:

npm install

🤖 Running socialite

node app.js

Run Without Docker

Go to client folder

cd .\client\

run the command

npm i

Return to Socialite folder

cd ..

Go to the server folder

cd .\server\

run the command

npm i

install nodemon in the system :

Reason: Nodemon monitors the files in your project for any changes. When it detects a change, it automatically restarts your Node.js application. This eliminates the need for manual restarts, making the development process more efficient. I. Open Windows PowerShell in run as administrator mode II. run the command
```
npm install -g nodemon
```
III. In case of an error run the following command
```
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
```
IV. Again run command II
In the client folder run the command

npm start

In the server folder run the command

nodemon index.js

Update the mongo_db link in .env file
Restart the server because the .env has changed IMPORTANT .

🧪 Tests

npm test

🛣 Roadmap

socialite

mern stack social media app

Progress:

Backend ⚙️

Real Time Chat
Dockerization
Caching using redis

Frontend 🚀

Better Ux
Comment section
Ui implementation of Chat window

🤝 Contributing

🌟 Contributions are always welcome! 🤝✨ Please follow these steps: 🚀

Fork the project repository. This creates a copy of the project on your account that you can modify without affecting the original project.
Clone the forked repository to your local machine using a Git client like Git or GitHub Desktop.

     git clone https://github.com/arnab2001/socialite.git

Create a new branch with a descriptive name (e.g., new-feature-branch or bugfix-issue-123).

git checkout -b new-feature-branch

Make changes to the project's codebase.
Commit your changes to your local branch with a clear commit message that explains the changes you've made.

git commit -m 'feat:  new feature.'

Push your changes to your forked repository on GitHub using the following command

git push origin new-feature-branch

Create a new pull request to the original project repository. In the pull request, describe the changes you've made and why they're necessary. The project maintainers will review your changes and provide feedback or merge them into the main branch.

Syncing with Upstream 🔄

If the original repository has been updated, sync your fork to include the latest changes:

Add Upstream Remote:

Add the upstream repository as a remote.

git remote add upstream https://github.com/arnab2001/socialite.git

Fetch Upstream Changes:
- Fetch the changes from the upstream repository.
```
git fetch upstream
```
Merge Upstream Changes:
- Merge the changes from the upstream repository into your local branch.
```
git merge upstream/main
```
Push Changes to Your Fork:
- Push the updated changes to your fork on GitHub.
```
git push origin main
```

Rollback a Commit ⏪

If you need to undo a commit, you can use the following command: ⚠️🔄

git revert <commit-hash>

Replace with the actual hash of the commit you want to revert.

📄 License

This project is licensed under the ℹ️ LICENSE-TYPE License. See the LICENSE-Type file for additional info.

👏 Acknowledgments

Development Resources

Here are some valuable resources for web development using React.js, Node.js, and Docker:

React.js

Official React Documentation: React Documentation
React - A JavaScript library for building user interfaces.

Node.js

Official Node.js Documentation: Node.js Documentation
Node.js - JavaScript runtime built on Chrome's V8 JavaScript engine.

Docker

Official Docker Documentation: Docker Documentation
Docker - Platform for developing, shipping, and running applications in containers.

Contributors ✨

Gratitude is extended to these amazing individuals 💜

_{Arnab Chatterjee}

_{Ankan Pal}

_{Sneha123-zudo}

_{Abhraneel Karmakar}

arnab2001 / socialite Goto Github PK

socialite's Introduction