GoQnA-Knowledge-Sharing-Platform

Technology Stack

Frontend

Backend

[!NOTE] Express.js is currently scaffolded for future backend expansion—Firebase handles most real-time and auth functionality.

Development Tools

• ESLint + Prettier (Code Quality)
• PostCSS (CSS Processing)
• Concurrently (Parallel Scripts)
• Date-fns (Date Formatting)

Installation

[!IMPORTANT] Make sure Node.js ≥18.x and a configured Firebase project are available before setup.

Prerequisites

• Node.js ≥18.x
• Firebase Project
• Git

Setup Steps

1. Clone repository:

git clone https://github.com/ravikant-diwakar/GoQnA-Knowledge-Sharing-Platform.git
cd GoQnA-Knowledge-Sharing-Platform

2. Install dependencies:

npm install
cd src/firebase && npm install

3. Firebase Configuration:

# Create .env file in root directory
VITE_FIREBASE_API_KEY=your_key
VITE_FIREBASE_AUTH_DOMAIN=your_project.firebaseapp.com
VITE_FIREBASE_PROJECT_ID=your_project_id
VITE_FIREBASE_STORAGE_BUCKET=your_bucket
VITE_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
VITE_FIREBASE_APP_ID=your_app_id

4. Start development servers:

npm run dev:all

[!TIP] Use npm run dev:allto run both frontend and backend in parallel during local development.

Project Structure

├── server/               # Express API endpoints
├── src/
│   ├── components/       # Reusable UI components
│   ├── context/          # React Context providers
│   ├── firebase/         # Firebase configuration
│   ├── hooks/            # Custom React hooks
│   ├── pages/            # Route components
│   └── types/            # TypeScript definitions
├── public/               # Static assets
└── tailwind.config.js    # Tailwind configuration

Key Implementation Details

Authentication Flow

sequenceDiagram
    User->>Frontend: Login/Signup
    Frontend->>Firebase: Auth Request
    Firebase->>Frontend: JWT Token
    Frontend->>Local Storage: Store Token
    Frontend->>Firestore: User Profile Data

Execution Flow

1. User Journey:

sequenceDiagram
    User->>React: Navigate to /ask
    React->>Firebase: Check auth state
    Firebase->>React: Auth status
    alt Authenticated
        React->>User: Show question form
        User->>React: Submit question
        React->>Firestore: Add document
    else Not Authenticated
        React->>User: Redirect to /login
    end

2. Data Flow:

// Typical data fetching pattern
const { data, loading, error } = useFirestore<Question>('questions')
  .getDocuments(
    [/* query conditions */],
    'createdAt', 
    'desc', 
    20
  );

[!NOTE] This pattern ensures real-time sync and paginated fetching for Firestore collections.

[!CAUTION] This architecture provides a scalable foundation but requires additional security measures and error handling for production readiness. The Firebase-centric approach enables rapid development but needs careful attention to security rules and query optimization.

Data Modeling

Question Document

interface Question {
  title: string;
  body: string;
  tags: string[];
  views: number;
  upvotes: number;
  answerCount: number;
  isSolved: boolean;
  createdAt: Timestamp;
  userId: string;
}

Security

[!WARNING] The following Firestore rules are minimal and intended for development only.

[!IMPORTANT] You must customize these rules before deploying to production to prevent unauthorized access.

Production deployment requires Firestore Security Rules:

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    match /questions/{questionId} {
      allow read: if true;
      allow create: if request.auth != null;
      allow update, delete: if request.auth.uid == resource.data.userId;
    }
  }
}

Contributing

We welcome contributions! Please follow these steps:

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.