Orgs model

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

@@ -0,0 +1,20 @@
+# This file was auto-generated by the Firebase CLI
+# https://github.com/firebase/firebase-tools
+
+name: Deploy to Firebase Hosting on merge
+'on':
+  push:
+    branches:
+      - main
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - run: cd volunteerverse-ui && npm ci && npm run build
+      - uses: FirebaseExtended/action-hosting-deploy@v0
+        with:
+          repoToken: '${{ secrets.GITHUB_TOKEN }}'
+          firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_VOLUNTEERVERSE_3B6B2 }}'
+          channelId: live
+          projectId: volunteerverse-3b6b2

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

@@ -0,0 +1,17 @@
+# 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
+jobs:
+  build_and_preview:
+    if: '${{ github.event.pull_request.head.repo.full_name == github.repository }}'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - run: npm ci && npm run build
+      - uses: FirebaseExtended/action-hosting-deploy@v0
+        with:
+          repoToken: '${{ secrets.GITHUB_TOKEN }}'
+          firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_VOLUNTEERVERSE_3B6B2 }}'
+          projectId: volunteerverse-3b6b2

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+.DS_Store

README.md

@@ -2,7 +2,7 @@
 
 # SITE Capstone Project
 
-SITE Course Year: **20__**
+SITE Course Year: **2025**
 
 Cohort: **Add Company Sponsor Name**
 

package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "react-icons": "^4.10.1"
+  }
+}

planning/README.md

@@ -8,6 +8,34 @@ For each group deliverable, have **one member** of your pod submit a link to thi
 
 **All deliverables are due Friday by 6:00pm PDT**
 
-* **Project Proposal:** Week 4
+* ## **Project Proposal:** Week 4
+* Pod members and team name.
+  * Melyssa, Tom, Kelechi - VolunteerVerse
+* Problem Statement and Target Audience:
+  * Students find it difficult to find volunteer opportunities in their local area.
+* Brief Description:
+  * The main purpose of our project is to enable students to easily search volunteer opportunities within their location. It will also allow organizations
+  * in need of volunteers to register volunteer opportunities and recruit volunteers. 
+* Expected Feature List.
+  * Home Page
+  * Account creation
+  * Student Profile
+  * Organization Profile
+  * Search/filtering for areas of interest
+  * User stats (keep data on the volunteering period)
+  * Email verification
+  * Feature that tracks registered opportunities
+
+Related Work: What similar apps and websites? How will your project stand out from these other websites?
+  * VolunteerMatch
+  * Ours will be specifically tailored towards students and interns.
+  * Modern and easy-to-use interface
+  * Provide resources on what it means to be a good volunteer. 
+
+Open Questions.
+  * How fo we retrieve data from different organizations in different locations?
+  * How can we implement email verification?
+
+
 * **User Stories:** Week 5
 * **Development Plan:** Week 6

planning/project_plan.md

@@ -1,28 +1,62 @@
 # Project Plan
 
-Pod Members: **Add Pod Members Names**
+Pod Members: **Tom, Kelechi, Melysssa**
 
-## Problem Statement and Description
+## Problem Statement
 
-Insert the latest summary of your problem statement and app description.
+Organizations struggle to find volunteers with tech-related skills to help with outreach, brand exposure. 
 
-## User Roles and Personas
+## User Roles
 
-Include the most up-to-date user roles and personas.
+- Students: A user who is looking to find tech volunteer opportunities in their industry of interest
 
-## User Stories
+- Tech Orgs : a user who is looking to find helpful skilled volunteers
 
-List the current user stories you will implement.
+## User Personas
 
-## Pages/Screens
+Include at least 2 personas per User Role
+### Students
+- Persona 1:
+    - Maya (21 years old) is a college student majoring in Design and aspiring to become a UX/UI designer. They are looking for opportunities to gain hands-on experience in designing mobile applications to boost their resume and develop their career. Maya is motivated to work with an organization where they can contribute to the UX/UI design of mobile applications, apply their skills, and learn from experienced professionals in the field.
 
-List all the pages and screens in the app. Include wireframes for at least 3 of them.
+- User Persona 2:
+    - Liam (20 years old) is a coding bootcamp fellow, currently enrolled in a program to enhance their skills as a software engineer. Liam is actively seeking opportunities where they can apply and develop their front-end development knowledge. Liam is looking to gain experience but is finding it difficult to find these opportunties from searches online.
+
 
-## Data Model
+### Org 
+- Persona 1:
+    -   Alex (34 years old) is the owner of a non-profit organization focused on environmental conservation. The organization currently lacks an online presence and needs a website to showcase their mission, projects, and volunteer opportunities. Alex is motivated to find specific tech volunteers who can help build a professional and engaging website for their organization, allowing them to reach a wider audience and increase community involvement.
+
+- User Persona 2:
+    - Emily (28 years old) is the owner of a non-profit organization that develops mobile applications to address community needs. They are in the testing phase of their latest app and need to find specific tech volunteers who can help test and provide feedback on the mobile application. Emily's motivation is to ensure the app functions well, identifies potential bugs, and receives valuable user feedback to improve its usability and performance.
+
+
+## User Stories
+- As a student, I should see a landing page that displays visual and descriptive information about the website before signing up so I know what I'm getting into. 
+- As a student, I should be able to create a profile that includes information about my skills/technical background and interest.
+- As a student I should see a personalized feed of volunteer opportunities that align with my skillset/interests.
+- As a student I should be able to apply/register for volunteer opportunities displayed on my feed
+- As a student, I should see a dashboard of all the volunteer projects I have applied for.
 
-Describe your app's data model using diagrams or tables
+- As an org owner, I should be able to post new volunteer projects, so that I can attract new volutneers.
+- As an org owner, I should input a description with tags, and a title to for each project.
+- As an org owner, I should see a list volunters/students who have signed up for my project.
+- As an org owner, I should approve which of the applied volunteers to volunteer on my posted project.
+
+
+
+## Pages/Screens
+- Login in
+- Registration
+- Landing Page
+- Profile setup (student)
+- Profile setup (org)
+- Volunteer Feed Page (students)
+- Projects page (org)
+List all the pages and screens in the app. Include wireframes for at least 3 of them.
 
-## Endpoints
+## Data Model + Endpoints
+[Data Model + Endpoints](https://docs.google.com/document/d/1LCH0YufzCk89B7lDG31BQJEKI0AJA0DW-cBulcN2Db4/edit?usp=sharing)
 
 List the API endpoints you will need to implement.
 

planning/project_proposal.md

@@ -1,23 +1,26 @@
-# Project Proposal
-
-Pod Members: **Add Pod Members Names**
-
-## Problem Statement
-
-Insert your groups problem statement and target audience.
-
-## Description
-
-What is the main purpose of your project? What are the key features your site has to offer its users? How will your targeted audience use your website?
-
-## Expected Features List
-
-Add a list of your groups's brainstormed features list
-
-## Related Work
-
-What similar apps and websites? How will your project stand out from these other websites?
-
-## Open Questions
-
-What questions do you still have? What topics do you need to research more for your project?
+# Pod members and team name.
+  * Melyssa, Tom, Kelechi - The KMT   Team
+# Problem Statement and Target Audience:
+  * Students find it difficult to find volunteer opportunities in their local area.
+# Brief Description:
+  * The main purpose of our project is to enable students to easily search volunteer opportunities within their location. It will also allow organizations
+  * in need of volunteers to register volunteer opportunities and recruit volunteers. 
+# Expected Feature List.
+  * Home Page
+  * Account creation
+  * Student Profile
+  * Organization Profile
+  * Search/filtering for areas of interest
+  * User stats (keep data on the volunteering period)
+  * Email verification
+  * Feature that tracks registered opportunities
+
+# Related Work: What similar apps and websites? How will your project stand out from these other websites?
+  * VolunteerMatch
+  * Ours will be specifically tailored towards students and interns.
+  * Modern and easy-to-use interface
+  * Provide resources on what it means to be a good volunteer. 
+
+# Open Questions.
+  * How fo we retrieve data from different organizations in different locations?
+  * How can we implement email verification?

planning/user_stories.md

@@ -4,22 +4,43 @@ Pod Members: **Add Pod Members Names**
 
 ## Problem Statement
 
-Insert your groups problem statement and target audience.
+Students find it difficult to find tech volunteer opportunties. 
 
 ## User Roles
 
-Include at least at least 1, but no more than 3, user roles
+- Students: A user who is looking to find tech volunteer opportunities in their industry of interest
+
+- Tech Orgs : a user who is looking to find helpful skilled volunteers
 
 ## User Personas
 
 Include at least 2 personas per User Role
+### Students
+- Persona 1:
+    - Maya (21 years old) is a college student majoring in Design and aspiring to become a UX/UI designer. They are looking for opportunities to gain hands-on experience in designing mobile applications to boost their resume and develop their career. Maya is motivated to work with an organization where they can contribute to the UX/UI design of mobile applications, apply their skills, and learn from experienced professionals in the field.
 
-## User Stories
+- User Persona 2:
+    - Liam (20 years old) is a coding bootcamp fellow, currently enrolled in a program to enhance their skills as a software engineer. Liam is actively seeking opportunities where they can apply and develop their front-end development knowledge. Liam is looking to gain experience but is finding it difficult to find these opportunties from searches online.
+
 
-Include at least 10 user stories.
+### Org 
+- Persona 1:
+    -   Alex (34 years old) is the owner of a non-profit organization focused on environmental conservation. The organization currently lacks an online presence and needs a website to showcase their mission, projects, and volunteer opportunities. Alex is motivated to find specific tech volunteers who can help build a professional and engaging website for their organization, allowing them to reach a wider audience and increase community involvement.
 
-1. **As a [user role], I want to [what], so that [why]**
+- User Persona 2:
+    - Emily (28 years old) is the owner of a non-profit organization that develops mobile applications to address community needs. They are in the testing phase of their latest app and need to find specific tech volunteers who can help test and provide feedback on the mobile application. Emily's motivation is to ensure the app functions well, identifies potential bugs, and receives valuable user feedback to improve its usability and performance.
+
 
-## Wireframe (Bonus)
+## User Stories
+- As a student, I should see a landing page that displays visual and descriptive information about the website before signing up so I know what I'm getting into. 
+- As a student, I should be able to create a profile that includes information about my skills/technical background and interest.
+- As a student I should see a personalized feed of volunteer opportunities that align with my skillset/interests.
+- As a student I should be able to apply/register for volunteer opportunities displayed on my feed
+- As a student, I should see a dashboard of all the volunteer projects I have applied for.
+
+- As an org owner, I should be able to post new volunteer projects, so that I can attract new volutneers.
+- As an org owner, I should input a description with tags, and a title to for each project.
+- As an org owner, I should see a list volunters/students who have signed up for my project.
+- As an org owner, I should approve which of the applied volunteers to volunteer on my posted project.
 
-Insert link or image to your group's wireframe. 
+## Wireframe (Bonus)

reflections/reflection2.md

@@ -1,25 +1,29 @@
 # Reflection #2
 
-Pod Members: **Add Pod Members Names**
+Pod Members: Kelechi, Melyssa, Tom
 
 ## Reflection Questions
 
 * Name at least one successful thing this week.
 
- Add response here
+ Deployment 
 
 * What were some challenges you and/or your group faced this week?
 
- Add response here
+ Webscrapping(populating the database with the webscrapped data), 
+ Cutting down some features
+ Testing
+ Debugging 
 
 * Did you finish all of your tasks in your sprint plan for this week? If you did not finish all of the planned tasks, how would you prioritize the remaining tasks on your list?  (i.e over planned, did not know how to implement certain features, miscommunication from the team, had to pivot from original plans, etc.)
 
- Add response here
+ Yes
 
 * Did the resources provided to you help prepare you in planning and executing your capstone project sprint this week? Be specific, what resources did you find particularly helpful or which tasks did you need more support on?
 
- Add response here
+ Yes If advices count as ressources then i would say the advice we found most particularly helpful was getting help! The task we needed more support on was testing 
 
 * Which features and user stories would you consider “at risk”? How will you change your plan if those items remain “at risk”?
 
- Add response here
+ As a student I should see a personalized feed of volunteer opportunities that align with my skillset/interests.
+   This is largely because we have not populated our database, by monday(our next demo) it would be fixed!

volunteerverse-api/.env.template

@@ -0,0 +1,8 @@
+PORT=3001
+SECRET_KEY=SOMETHING_SUPER_SECRET_GOES_HERE
+DATABASE_USER=postgres
+DATABASE_PASS=postgres
+DATABASE_HOST=localhost
+DATABASE_PORT=5432
+DATABASE_NAME=volunteerverse
+BCRYPT_WORK_FACTOR=

volunteerverse-api/.eslintrc.js

@@ -0,0 +1,33 @@
+module.exports = {
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "overrides": [
+        {
+            "env": {
+                "node": true
+            },
+            "files": [
+                ".eslintrc.{js,cjs}"
+            ],
+            "parserOptions": {
+                "sourceType": "script"
+            }
+        }
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+    }
+}

volunteerverse-api/.gitignore

@@ -0,0 +1,5 @@
+node_modules
+dist
+.env
+node_modules
+

volunteerverse-api/babel.config.js

@@ -0,0 +1,12 @@
+module.exports = 
+  {
+    "presets": [
+      ["@babel/preset-env", {
+        "targets": {
+          "node": "current"
+        }
+      }],
+      "@babel/preset-typescript"
+    ]
+  }
+

volunteerverse-api/browser.js

@@ -0,0 +1,19 @@
+const puppeteer = require('puppeteer');
+
+async function startBrowser(){
+	let browser;
+	try {
+	    console.log("Opening the browser......");
+	    browser = await puppeteer.launch({
+	        headless: "new"
+
+	    });
+	} catch (err) {
+	    console.log("Could not create a browser instance => : ", err);
+	}
+	return browser;
+}
+
+module.exports = {
+	startBrowser
+};