Get Link Up with your friends anywhere and anytime 🔗
A MERN stack project that wants to be a social media when it grows up
Welcome to the LinkUp! This is a MERN stack project that provides an attractive and seamless chatting experience. With its user-friendly interface and advanced features, this application allows users to engage in real-time conversations with others, keeping them connected and up to date.
🌟 Table of contents
- 📋 Documentation
- 🚀 Features
- 📦 Installation and Setup
- 📝 Contributing
- ⚖️ License
- ✨ Contributors
- 🤝 Contact
🚀 Features
- 🔒 Secure Authentication: Enjoy a safe and secure login process with options for traditional credentials and seamless Google authentication.
- 🌈 Aesthetic Interface: Experience an attractive and visually pleasing chat interface that enhances your conversations and keeps you engaged.
- ✉️ Real-Time Chat: Engage in seamless and real-time conversations with your friends and stay connected anywhere, anytime.
- 💡 Online Status and Last Seen: Stay informed about the availability of your chat contacts with online status indicators and last seen timestamps.
- 💪 Persistent User Data: Your user data is securely stored and managed in a MongoDB database, ensuring seamless sign-in and personalized chat experiences.
- 📱 Mobile-Responsive Design: Access LinkUp on your mobile devices and enjoy a fully responsive design that adapts to different screen sizes. (not yet actually)
- 🎨 Attractive UI Libraries: Utilizes libraries like Bootstrap and framer-motion to create a modern and visually appealing user interface.
- 🤝 Open-Source Project: LinkUp is an open-source project, welcoming contributions from the community to enhance its features and functionality.
📦 Installation and setup
To run LinkUp locally on your machine, follow these steps:
- Clone the repository from GitHub:
git clone https://github.com/your-username/linkup.git- Install the dependencies for the server:
cd linkup-backend
npm install- Install the dependencies for the client:
cd ../linkup-frontend
npm install- Set up the environment variables:
cp ./env_sample/.env.backend.sample ./linkup-backend/.env
cp ./env_sample/.env.frontend.sample ./linkup-frontend/.env- Start the development server:
- Run the server:
cd ../linkup-backent
npm start- Run the client:
cd ../linkup-frontend
npm start- Access LinkUp in your web browser:
http://localhost:3000For automatic setup
run setup.sh in terminal
📝 Contributing
We welcome contributions from the community to enhance LinkUp further. To Contribute please visit CONTRIBUTING.md
✨ Contributors
A big thanks to these amazing people who have contributed to this project 🎉
🤝 Contact
If you have any questions, suggestions, or feedback regarding LinkUp, please feel free to contact me at arpittyagi102@gmail.com, or message me on Linkedin