Skip to content

Latest commit

 

History

History
138 lines (97 loc) · 3.71 KB

README.md

File metadata and controls

138 lines (97 loc) · 3.71 KB

DevTinder 💻❤️

DevTinder is a MERN stack-based application that connects like-minded developers. Inspired by Tinder, it allows developers to interact, connect, and build meaningful professional relationships.

Try DevTinder 🚀

DevTinder Preview Part 1 DevTinder Preview Part 2 DevTinder Preview Part 3
DevTinder Preview Part 1 DevTinder Preview Part 2 DevTinder Preview Part 3

Table of Contents 📚

Features 🎯

  • ✅ User can create an account.
  • ✅ User can sign in.
  • ✅ Feed displaying developer profiles.
  • ✅ Ability to mark profiles as Interested or Ignore.
  • ✅ Connection requests are sent to Interested profiles.
  • ✅ View and manage received connection requests (Accept/Reject).
  • ✅ Accepted requests appear in the Connections tab.
  • ✅ Edit profile details on the Profile page.
  • ✅ Securely sign out.

Tech Stack 🛠️

  • Frontend: React.js, Redux ⚛️
  • Backend: Node.js, Express.js 🌐
  • Database: MongoDB, Mongoose 🗄️
  • Authentication: JWT 🔐

Setup and Installation 🏗️

Follow these steps to get the project running on your local machine:

Prerequisites 📋

  • Node.js and npm installed. 🟢
  • MongoDB instance running locally or in the cloud. 🗂️

Clone the Repository 📂

git clone https://github.com/akshaygelani/devtinder.git
cd devtinder

Install Dependencies 🔧

For the Backend

cd backend
npm install

For the Frontend

cd frontend
npm install

Environment Variables 🔑

  • Create a .env file in the backend and frontend directory
  • Refer .env.sample in the respective directory

Running the Development Server 🚀

Start the Backend

cd backend
npm run dev

Start the Frontend

cd frontend
npm run dev

By default:

  • Backend runs at http://localhost:3000
  • Frontend runs at http://localhost:3001

Building the Project 🚀

For the Frontend

cd frontend
npm run build

This will generate a production-ready build of the frontend in the dist folder.

Upcoming Features 🌟

  • More validations and data sanitization in APIs
  • Frontend Input validations
  • Adding API Tests and UI Tests
  • Real-time chat with connections. 💬
  • Personalized feed suggestions based on skills and interest. 🤖
  • Notifications for new connection requests. 🔔
  • Many more to come... 🚀

Contributing 🤝

Contributions are welcome! If you’d like to contribute, follow these steps:

  1. Fork the repository. 🍴
  2. Create a new branch (git checkout -b feature/your-feature-name). 🌱
  3. Commit your changes (git commit -m 'Add some feature'). ✍️
  4. Push to the branch (git push origin feature/your-feature-name). 📤
  5. Open a pull request. 🔁

License 📜

This project is licensed under the MIT License. See the LICENSE file for details.

Happy Coding!