This project is a full-stack application built with React, Node.js, Express, and MongoDB. The frontend is managed using Vite, and the backend handles authentication, user profile management, and other API routes.

Getting Started

Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Node.js (v14 or later)
• npm (v6 or later)

Installation

1. Clone the repository:

   git clone https://github.com/adityasatuluri/flex-chat.git
   cd flex-chat

2. Install server dependencies:

   cd server
   npm install

3. Install client dependencies:

   cd ../client
   npm install

Running the Project

1. Start the server: Add "dev": "nodemon index.js" in "scripts" of the _package.json_ file and run the below command

   cd server
   npm run dev

   The server will start on http://localhost:6969.

2. Start the client:

   cd ../client
   npm run dev

   The client will start on http://localhost:5173.

Project Structure

• server: Contains the Express server, authentication logic, and API routes.
• client: Contains the React application managed by Vite.

Stack

• Frontend:

  • React
  • Vite
  • Tailwind CSS
  • React Icons

• Backend:

  • Node.js
  • Express
  • MongoDB
  • JWT (JSON Web Tokens) for authentication
  • bcrypt for password hashing
  • Socket.io for faciliating realtime connections
  • Multer for file uploads
  • zustand for state management

Environment Variables

Modify the .env file in the server directory by replacing the following environment variables:

• MONGO_URI=your_mongodb_uri
• JWT_KEY=your_jwt_secret_key

API Endpoints

• Authentication Routes:

  • POST /api/auth/signup - User signup
  • POST /api/auth/login - User login
  • GET /api/auth/user-info - Get user information (requires token)
  • POST /api/auth/update-profile - Update user profile (requires token)
  • POST /api/auth/add-profile-image - Add profile image (requires token)
  • POST /api/auth/remove-profile-image - Remove profile image (requires token)
  • POST /api/auth/log-out - User logout

• Contacts Routes:

  • GET /api/contacts/search - Search contacts
  • GET /api/contacts/get-contacts-for-dm - Get direct message contacts

• Messages Routes:

  • GET /api/messages/get-messages - Get all messages
  • POST /api/messages/upload-file - Upload file

Additional Information

• Ensure MongoDB is running and accessible from your development environment.
• Update any relevant configurations in the client and server as needed.

👨‍💻 Developed by

• Aditya Satuluri 🚀