Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 44 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
## 📚 Table of Contents

- [About the Project](#-profile-rank-fitfinder--find-opportunities-meant-for-you)

- [What Can You Do with Profile Rank?](#-what-can-you-do-with-profile-rank)

- [Tech Stack](#-tech-stack)
- [Pages in the MVP](#-pages-in-the-mvp)
- [Getting Started](#-getting-started)
- [How to Contribute](#-how-to-contribute)
- [Areas You Can Contribute To](#-areas-you-can-contribute-to)
- [Community and Help](#-community-and-help)
- [Project Maintainers](#-project-maintainers)
- [WOCS Mentors](#-wocs-mentors)
- [Code of Conduct](#-code-of-conduct)
- [Support the Project](#-support-the-project)

# 🎯 Profile Rank (FitFinder) – Find opportunities Meant for You

Welcome to **Profile Rank**, a smart and community-driven platform where you can discover **global scholarships, conferences, hackathons, research programs, apprenticeships, and more**, all based on your profile.
Expand All @@ -9,17 +26,19 @@ Welcome to **Profile Rank**, a smart and community-driven platform where you can
## 🌍 What Can You Do with Profile Rank?

✨ **Discover Opportunities**
Search or browse through opportunities curated by other users:
- 🎓 Scholarships
- 🧑‍🔬 Research Programs
- 🧑‍🏫 Apprenticeships
- 🧑‍💻 Hackathons
Search or browse through opportunities curated by other users:

- 🎓 Scholarships
- 🧑‍🔬 Research Programs
- 🧑‍🏫 Apprenticeships
- 🧑‍💻 Hackathons
- 🌎 Conferences

... and see if you're a good fit or what you can do to become one.

🧠 **Find Your Fit**
Once you create your **FitProfile**, the system will show you how well you match with each opportunity using a percentage based on your:

- Skills
- Education & GPA
- Location
Expand All @@ -40,7 +59,7 @@ Save opportunities, view past submissions, and help others in any way you can.
## 🧰 Tech Stack

| Part | Tech Used |
|----------------|-------------------------------------|
| -------------- | ----------------------------------- |
| Frontend | React.js, TailwindCSS |
| Backend | Node.js with Express or Firebase |
| Database | MongoDB or Firebase Realtime DB |
Expand All @@ -53,22 +72,26 @@ Save opportunities, view past submissions, and help others in any way you can.

## 💻 Pages in the MVP

1. **Home** – Overview of platform and highlights of other sections
2. **Opportunities** – List view with filters (type, location, deadline, fit score), full info, apply link, success stories, and chance level
3. **Submit Opportunity** – Form to submit a new opportunity (login required)
4. **My Dashboard** – Saved opportunities, fit history, profile editor
5. **FitProfile Setup** – Onboarding flow or edit page
6. **Success Stories** – A separate feed of real user stories and tips
1. **Home** – Overview of platform and highlights of other sections
2. **Opportunities** – List view with filters (type, location, deadline, fit score), full info, apply link, success stories, and chance level
3. **Submit Opportunity** – Form to submit a new opportunity (login required)
4. **My Dashboard** – Saved opportunities, fit history, profile editor
5. **FitProfile Setup** – Onboarding flow or edit page
6. **Success Stories** – A separate feed of real user stories and tips
7. **Admin Panel (optional)** – For moderators to approve or reject opportunities

---

<a id="-getting-started"></a>

## 🧑‍💻 Getting Started

> Ready to contribute? We welcome beginners! 🙌

### 📦 Prerequisites

Make sure you have:

- Git and GitHub account
- Node.js and npm installed
- Code editor (VS Code recommended)
Expand All @@ -86,18 +109,20 @@ Open `http://localhost:3000` in your browser.

---

<a id="-how-to-contribute"></a>

## 🛠️ How to Contribute

We follow beginner-friendly open source practices.

### 📌 Step-by-Step Guide

1. Go to the [Issues](https://github.com/Code-Social/fitfinder/issues) tab
2. Look for labels like `good first issue`, `help wanted`, or `feature request`
3. Comment on the issue to get assigned
4. **Fork** the repo
5. Create a new branch (e.g., `feature/form-validation`)
6. Make your changes
1. Go to the [Issues](https://github.com/Code-Social/fitfinder/issues) tab
2. Look for labels like `good first issue`, `help wanted`, or `feature request`
3. Comment on the issue to get assigned
4. **Fork** the repo
5. Create a new branch (e.g., `feature/form-validation`)
6. Make your changes
7. Create a Pull Request (PR) – we'll review and guide you

### 🔁 Example Commands
Expand Down Expand Up @@ -129,6 +154,7 @@ git push origin feature/profile-card
## 💬 Community and Help

Questions? Ideas? Join us here:

- 💬 [Discord](https://discord.gg/MSTNyRSPYW)
- 💡 [Instagram](https://instagram.com/codesocial.tech)
- 🌐 [Website](https://codesocial.tech)
Expand Down