Skip to content

Latest commit

Β 

History

History
516 lines (366 loc) Β· 21.5 KB

README.md

File metadata and controls

516 lines (366 loc) Β· 21.5 KB
Alt Text

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.

SVG JavaScript .ENV HTML5 React Docker GitHub%20Actions JSON Markdown Express

Open Source Love svg1 PRs Welcome Visitors GitHub forks GitHub Repo stars GitHub contributors GitHub last commit GitHub repo size GitHub total lines Github GitHub issues GitHub closed issues GitHub pull requests GitHub closed pull requests GitHub top language


πŸ“– Table of Contents


πŸ“ Overview

Light Mode

t1

Dark Mode

t2


πŸ“¦ 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

  1. Clone the socialite repository:
git clone https://github.com/arnab2001/socialite
  1. Change to the project directory:
cd socialite
  1. Install the dependencies:
npm install

πŸ€– Running socialite

node app.js

Run Without Docker

  1. Go to client folder
cd .\client\
  1. run the command
npm i
  1. Return to Socialite folder
cd ..
  1. Go to the server folder
cd .\server\
  1. run the command
npm i
  1. 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

  2. In the client folder run the command

npm start
  1. In the server folder run the command
nodemon index.js
  1. Update the mongo_db link in .env file
  2. 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: πŸš€

  1. Fork the project repository. This creates a copy of the project on your account that you can modify without affecting the original project.
  2. 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
  1. Create a new branch with a descriptive name (e.g., new-feature-branch or bugfix-issue-123).
git checkout -b new-feature-branch
  1. Make changes to the project's codebase.
  2. 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.'
  1. Push your changes to your forked repository on GitHub using the following command
git push origin new-feature-branch
  1. 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:

  1. Add Upstream Remote:

    • Add the upstream repository as a remote.
      git remote add upstream https://github.com/arnab2001/socialite.git
  2. Fetch Upstream Changes:

    • Fetch the changes from the upstream repository.
      git fetch upstream
  3. Merge Upstream Changes:

    • Merge the changes from the upstream repository into your local branch.
      git merge upstream/main
  4. 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




Arnab Chatterjee




Ankan Pal




Sneha123-zudo




Abhraneel Karmakar


logo