Credily App!

This project is structured into separate frontend and backend directories.

Project Structure

• frontend/ - React frontend built with Vite
• backend/ - Node.js backend

Setup Instructions

Root Directory Setup

1. First, install dependencies in the root directory:

   npm install
   

   This will set up the necessary packages for the project root.

Frontend Setup

1. Navigate to the frontend directory and install dependencies:

   cd frontend
   npm install
   

2. Create a .env file with your API port:

   VITE_API_PORT=5000  # or 4000 based on your preference
   

3. Start the development server:

   npm run dev
   

Backend Setup

1. Navigate to the backend directory and install dependencies:

   cd backend
   npm install
   

2. Create a .env file with:

   PORT=5000  # or 4000 based on your preference
   MONGODB_URI=your_connection_string_from_table_below
   JWT_SECRET=your_jwt_secret
   NODE_ENV=development
   
   # Cloudinary credentials (required for image uploads)
   # Create an account at cloudinary.com and get these from your dashboard
   CLOUDINARY_CLOUD_NAME=ds6xri71k
   CLOUDINARY_API_KEY=632696559246236
   CLOUDINARY_API_SECRET=PaT4mWgag51BgW_dpK835_W8Fhc   # Google Cloud credentials for sentiment analysis
   GOOGLE_APPLICATION_CREDENTIALS=./config/google-credentials.json
   USE_REAL_SENTIMENT=true
   

   Note: The Cloudinary variables are essential for profile picture uploads and other media storage features. Create a free account at cloudinary.com to get your credentials.

3. Google Cloud Setup: You need to add the google-credentials.json file in the backend/config directory. This file contains the credentials for Google Cloud services used for sentiment analysis.

   If you don't add this file, sentiment analysis features will not work correctly.

4. Start the backend server:

   npm run dev
   

5. To test your database connection:

   node test-db-connection.js
   

Supporting Different Port Configurations

Some team members use port 4000, while others use port 5000. To avoid code conflicts:

1. Use the environment variables in both frontend and backend as shown above
2. Keep .env files in your .gitignore to avoid committing personal configurations

MongoDB Atlas Connection

Find your connection string from the list below:

Team Member	Connection String
Jahanzeb Babar	mongodb+srv://mbabarbscs23seecs:4231@cluster0.2wkplzo.mongodb.net/Credily?retryWrites=true&w=majority&appName=Cluster0
Shaheer Saleh	mongodb+srv://msalehbscs23seecs:4231@cluster0.2wkplzo.mongodb.net/Credily?retryWrites=true&w=majority&appName=Cluster0
Roshan Jalil	mongodb+srv://rjalilbscs23seecs:4231@cluster0.2wkplzo.mongodb.net/Credily?retryWrites=true&w=majority&appName=Cluster0
Syed Fawwad Ahmed	mongodb+srv://sfahmedbscs23seecs:4231@cluster0.2wkplzo.mongodb.net/Credily?retryWrites=true&w=majority&appName=Cluster0
Syed Ali Hassan Jaffri	mongodb+srv://sjaffribscs23seecs:4231@cluster0.2wkplzo.mongodb.net/Credily?retryWrites=true&w=majority&appName=Cluster0

Troubleshooting Connection Issues

• Verify you're using the correct connection string
• Check your internet connection
• Confirm MongoDB Atlas service is running
• For persistent issues, contact Fawwad

Note: The MongoDB cluster allows connections from any IP address (0.0.0.0/0). For production, we should implement more restrictive access controls.

React + Vite

This template provides a minimal setup to get React working in Vite with HMR and ESLint rules.

Currently, two official plugins are available:

• @vitejs/plugin-react uses Babel for Fast Refresh
• @vitejs/plugin-react-swc uses SWC for Fast Refresh

Expanding the ESLint configuration

If you are developing a production application, we recommend using TypeScript with type-aware lint rules enabled. Check out the TS template for information on how to integrate TypeScript and typescript-eslint in your project.