Release 2

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: BUG - [feature_name]-[problem in a short sentence]
+labels: type:bug
+assignees: ''
+projects: marvelai-org/8
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,21 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[Feature Request] - Ability for users to [user action]"
+labels: type:new-feature
+assignees: ''
+projects: marvelai-org/8
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/suggest-an-improvement.md

@@ -0,0 +1,24 @@
+---
+name: Suggest an improvement
+about: suggesting improvements to a feature or technical improvements
+title: ''
+labels: enhancement
+assignees: ''
+projects: marvelai-org/8
+
+---
+
+Which feature do you want to improve? Please name the feature and what it does. 
+Feature name with a simple description of it's functionality. Ex. flashcard generator tool for generating flashcards based on user's requirements. 
+
+Is your improvement related to a problem? Please describe.
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+Describe the solution you'd like
+A clear and concise description of what you want to happen.
+
+Describe alternatives you've considered
+A clear and concise description of any alternative solutions or features you've considered.
+
+Additional context
+Add any other context or screenshots about the feature request here.

.github/workflows/firebase-hosting-merge.yml

@@ -6,144 +6,15 @@ on:
   push:
     branches:
       - main
-      - develop
 jobs:
-  build_and_deploy_sandbox:
-    name: "Deploy to Marvel Develop"
-    if: ${{ github.ref == 'refs/heads/develop' }}
+  build_and_deploy:
     runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v2
-        with:
-          node-version: "18.17.0"
-
-      - name: Install Firebase CLI
-        run: |
-          npm install -g firebase-tools
-
-      - name: Install Functions Dependencies
-        run: |
-          cd functions
-          npm install
-
-      - name: Decode Base64 Env Vars for Develop
-        if: github.ref == 'refs/heads/develop'
-        run: |
-          cd functions
-          echo "${{ secrets.SANDBOX_ENV_FILE_BASE64 }}" | base64 --decode > .env
-
-      - name: Deploy Functions to Develop
-        if: github.ref == 'refs/heads/develop'
-        run: |
-          set -o allexport
-          source functions/.env
-          set +o allexport
-          firebase deploy --only functions --force --token ${{ secrets.FIREBASE_TOKEN }} --project kai-platform-sandbox
-
-      - name: Decode and create .env file from secret
-        run: |
-          echo "${{ secrets.SANDBOX_ENV_FILE_BASE64 }}" | base64 --decode > .env
-
-      - name: Set environment variables
-        run: |
-          set -a
-          source .env
-          set +a
-
-      - name: Install Next.js globally
-        run: npm install -g next
-
-      - name: Build Next.js
-        run: npm run build:next
-
-      - name: Set Channel ID
-        id: set_channel_id
-        run: |
-          if [ "${{ github.event_name }}" = "push" ]; then
-            echo "channel_id=live" >> $GITHUB_ENV
-          else
-            echo "channel_id=pr-${{ github.event.pull_request.number }}" >> $GITHUB_ENV
-          fi
-
-      - name: Deploy to Firebase
-        uses: FirebaseExtended/action-hosting-deploy@v0
-        with:
-          repoToken: ${{ secrets.GIT_TOKEN }}
-          firebaseServiceAccount: ${{ secrets.FIREBASE_SERVICE_ACCOUNT_SANDBOX }}
-          projectId: kai-platform-sandbox
-          channelId: ${{ env.channel_id }}
-
-  build_and_deploy_production:
-    name: "Deploy to Marvel Production"
-    if: ${{ github.ref == 'refs/heads/main' }}
-    runs-on: ubuntu-latest
-
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v2
-        with:
-          node-version: "18.17.0"
-
-      - name: Install Firebase CLI
-        run: |
-          npm install -g firebase-tools
-
-      - name: Install Functions Dependencies
-        run: |
-          cd functions
-          npm install
-
-      - name: Decode Base64 Env Vars for Specific Branches
-        if: github.ref == 'refs/heads/main'
-        run: |
-          cd functions
-          echo "${{ secrets.PROD_ENV_FILE_BASE64 }}" | base64 --decode > .env
-
-      - name: Deploy Functions to Production
-        if: github.ref == 'refs/heads/main'
-        run: |
-          set -o allexport
-          source functions/.env
-          set +o allexport
-          firebase deploy --only functions --force --token ${{ secrets.FIREBASE_TOKEN }} --project kai-ai-f63c8
-
-      - name: Decode and create .env file from secret
-        run: |
-          echo "${{ secrets.PROD_ENV_FILE_BASE64 }}" | base64 --decode > .env
-
-      - name: Set environment variables
-        run: |
-          set -a
-          source .env
-          set +a
-
-      - name: Install Next.js globally
-        run: npm install -g next
-
-      - name: Build Next.js
-        run: npm run build:next
-
-      - name: Set Channel ID
-        id: set_channel_id
-        run: |
-          if [ "${{ github.event_name }}" = "push" ]; then
-            echo "channel_id=live" >> $GITHUB_ENV
-          else
-            echo "channel_id=pr-${{ github.event.pull_request.number }}" >> $GITHUB_ENV
-          fi
-
-      - name: Deploy to Firebase
-        uses: FirebaseExtended/action-hosting-deploy@v0
+      - uses: actions/checkout@v4
+      - run: next build
+      - uses: FirebaseExtended/action-hosting-deploy@v0
         with:
-          repoToken: ${{ secrets.GIT_TOKEN }}
+          repoToken: ${{ secrets.GITHUB_TOKEN }}
           firebaseServiceAccount: ${{ secrets.FIREBASE_SERVICE_ACCOUNT_KAI_AI_F63C8 }}
+          channelId: live
           projectId: kai-ai-f63c8
-          channelId: ${{ env.channel_id }}

.github/workflows/firebase-hosting-pull-request.yml

@@ -0,0 +1,21 @@
+# This file was auto-generated by the Firebase CLI
+# https://github.com/firebase/firebase-tools
+
+name: Deploy to Firebase Hosting on PR
+on: pull_request
+permissions:
+  checks: write
+  contents: read
+  pull-requests: write
+jobs:
+  build_and_preview:
+    if: ${{ github.event.pull_request.head.repo.full_name == github.repository }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: next build
+      - uses: FirebaseExtended/action-hosting-deploy@v0
+        with:
+          repoToken: ${{ secrets.GITHUB_TOKEN }}
+          firebaseServiceAccount: ${{ secrets.FIREBASE_SERVICE_ACCOUNT_KAI_AI_F63C8 }}
+          projectId: kai-ai-f63c8

.husky/pre-commit

@@ -1,14 +1,7 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-cd functions
-
-echo "Running linter on functions..."
-npm run lint
-
-cd ../frontend
-
-echo "Running linter on platform frontend..."
-npm run lint
-
+cd frontend
 
+echo "Running linter..."
+npm run lint

README.md

@@ -1,5 +1,21 @@
+![image](https://github.com/user-attachments/assets/04e5f5a4-9ba7-4887-a158-bca181f7391c)
+
+
 # Marvel AI Platform
-Marvel is an open source project by Radical having chatbot and smart tools for teachers.
+Marvel AI is an open-source project by Reality AI, designed to provide smart tools and chatbots to assist teachers in education. The platform leverages Firebase, Next.js, and various AI components to create a seamless learning experience.
+
+![Next.js](https://img.shields.io/badge/Next.js-12.3.0-blue)
+![React](https://img.shields.io/badge/React-18.2.0-blue)
+![Redux Toolkit](https://img.shields.io/badge/Redux%20Toolkit-%5E1.9.5-purple)
+![Emotion](https://img.shields.io/badge/Emotion-%5E11.11.0-pink)
+![MUI](https://img.shields.io/badge/MUI-%5E5.13.0-blue)
+![Firebase](https://img.shields.io/badge/Firebase-%5E9.22.0-orange)
+![Axios](https://img.shields.io/badge/Axios-%5E1.4.0-brightgreen)
+![React Hook Form](https://img.shields.io/badge/React%20Hook%20Form-%5E7.43.9-lightgrey)
+![Remark](https://img.shields.io/badge/Remark-%5E15.0.1-yellow)
+![ESLint](https://img.shields.io/badge/ESLint-%5E8.40.0-blue)
+![Prettier](https://img.shields.io/badge/Prettier-%5E2.8.8-ff69b4)
+![Husky](https://img.shields.io/badge/Husky-%5E9.0.11-yellow)
 
 ## Table of Contents
 
@@ -14,13 +30,13 @@ Marvel is an open source project by Radical having chatbot and smart tools for t
 ## Architecture
 The "Marvel" platform is structured into two main components: Firebase and AI. The Firebase side, detailed in this repository, encompasses both the frontend, developed with NextJS and hosted on Firebase Hosting, and the backend, which includes user management and session handling via Firebase Functions like `signUpUser` and `createChatSession`. The `communicator` and `toolCommunicator` functions act as proxies, facilitating interaction between the Firebase infrastructure and the AI services, ensuring seamless data flow and integration. Firestore DB is utilized for data storage. The AI components, housed in a separate repository, include a chatbot and tools like "Quizify" and "YouTube Flashcard Generator." 
 
-![Architecture Diagram](architecture.png)
+![Architecture Diagram](https://github.com/marvelai-org/marvel-platform/blob/2400bf1b10af77b57976778a108f3f2296aa5215/Marvel%20Architecture.png)
 
 ### Folder Structure
 ## Folder Structure Overview
 
-- **`/frontend`**:
-  Contains all the files related to the front-end application, including the NextJS app and associated resources.
+- **`/`**:
+  Standard firebase project structure, having frontend in the root and functions in the functions folder.
 
 - **`/functions`**:
   Houses the Firebase Functions, which are serverless functions responsible for backend processes such as AI chatbot and tools communicators
@@ -36,18 +52,18 @@ The "Marvel" platform is structured into two main components: Firebase and AI. T
   Security rules for Firestore database, defining read/write permissions.
 
 - **`package.json`** & **`package-lock.json`**:
-  Defines the project’s global dependencies
+  Defines the project’s frontend dependencies
 
 ## Prerequisites
-- Node.js (v14 or later)
+- Node.js (v18 or later)
 - Firebase CLI (v9.10.0 or later)
 - Google Firebase Account
 
 ## Setup
 To set up the project, follow these steps:
 
 ## Local Development
-1. Clone the repository: `git clone https://github.com/radicalxdev/marvel-platform`
+1. Clone the repository: `git clone https://github.com/marvelai-org/marvel-platform`
 2. Create your firebase project on google firebase console
 3. Create a firestore database instance
 4. Get firebase config from firebase project settings in firebase console and save it to .env (create in root of this project, see sample.env for refrence)
@@ -60,27 +76,36 @@ To set up the project, follow these steps:
 3. Run for local testing: `firebase serve --only functions`
 
 ### Frontend
-1. Navigate to front-end project directory: `cd frontend`
+1. Navigate to front-end project directory: `cd ../` (root of project)
 2. Install dependencies: `npm install`
 3. Run for local testing: `npm run dev`
+This will start the frontend on localhost:3000 (default port)
 
 ### Local Emulator (Optional)
 #### Setup
 1. Open the terminal and to start the emulators, run the following command: `npm run emulators`
-2. Open another terminal simultaneously and start the frontend project, run the following command: `npm run frontend:dev`
+2. Open another terminal simultaneously and start the frontend project, run the following command: `npm run dev`
 
 ## Cloud Deployment
-1. Clone the repository: `git clone https://github.com/radicalxdev/marvel-platform`
+1. Clone the repository: `git clone https://github.com/marvelai-org/marvel-platform`
 2. Navigate to back-end project directory: `cd functions`
 3. Install dependencies: `npm install`
-4. Navigate to front-end directory: `cd ../frontend`
+4. Navigate to front-end directory: `cd ../` (root of project)
 5. Install dependencies: `npm install`
-5. Navigate to the root directory and run deploy: `cd .. && npm run deploy`
+5. Navigate to the root directory and run deploy: `npm run deploy`
 
 ## Contributing
+1. Fork the Repository: Create a personal fork of the repository to work on.
+2. Create a Branch: For each new feature or bug fix, create a new branch from the develop branch.
+3. Implement Changes: Make your changes, ensuring they adhere to the project’s coding standards.
+4. Commit Changes: Commit your changes with clear, descriptive messages.
+5. Push to Your Fork: Push your changes to your forked repository.
+6. Open a Pull Request: Navigate to the original repository and open a pull request from your branch to the develop branch.
+7. Code Review: Engage in the code review process, addressing any feedback provided.
+8. Merge: Once approved, your changes will be merged into the develop branch.
 
-If you would like to contribute to the project, please follow the guidelines in the `CONTRIBUTING.md` file.
+For detailed instructions, refer to the [CONTRIBUTING.md](https://github.com/marvelai-org/marvel-platform/blob/2400bf1b10af77b57976778a108f3f2296aa5215/contributing.md) file in the repository.
 
 ## License
 
-This project is licensed under the [MIT License](LICENSE).
+This project is licensed under the [MIT License](LICENSE.md).