Project Description
NUReferrals, aims to tap into one branch of professional networking through referrals. Job seekers, especially students, can easily find and request referrals from industry professionals in their desired fields, significantly enhancing their chances of landing interviews and job offers. In addition, industry professionals can effortlessly discover qualified candidates to fill their referral slots through detailed applicant profiles, streamlining the hiring process. Our app also facilitates connections through industry-hosted events, allowing users to network face-to-face and engage with potential referrers directly.
- Introduction
- Features/Personas
- Tech Stack
- Setup and Installation
- Running the Project
- Environment Variables & Secrets
- Contributing
- Team Members
- License
Why does this project exist?
Did you know that an estimated 70-80% of all jobs are never posted? That hidden job market can only be reached through connections; experts suggest that around 80% of jobs are filled through networking (Forbes). Our app, NUReferrals, aims to tap into one branch of professional networking through referrals. Job seekers, especially students, can easily find and request referrals from industry professionals in their desired fields, significantly enhancing their chances of landing interviews and job offers. In addition, industry professionals can effortlessly discover qualified candidates to fill their referral slots through detailed applicant profiles, streamlining the hiring process. Our app also facilitates connections through industry-hosted events, allowing users to network face-to-face and engage with potential referrers directly.
ReferralsNU requires existing data on users and referrals to function meaningfully, and it generates new data with each interaction. This allows job seekers to leverage connections that can be tracked, analyzed, and managed over time for the best networking and employment outcomes. Our app also ensures that all interactions are safe and authentic through administrator verification. They can quickly verify user profiles, monitor referral activities, and facilitate effective communication about platform policies, ensuring that all members adhere to community standards. Co-op advisors can track student progress and facilitate networking opportunities, offering personalized guidance and networking opportunities tailored to individual users’ career goals.
There are 4 personas, or people that you can act as, when using NUReferrals
As an administrator, you have comprehensive oversight capabilities, allowing them to moderate all requests and remove any deemed inappropriate. They can manage existing connections, supervise communications between users, and ensure platform integrity. Additionally, admins can search messages by keyword and delete them if necessary to maintain a safe and professional environment.
As a referral seeker, you can search through your connections and reach out to referrers. Referral seekers are also able to view, update, and create their own requests and search through referrer profiles with filtering functionality to request referrals from. If students need guidance, they are also able to find advisor contact info in order to reach out.
As a co-op advisor, you need to be able to keep tabs on your students and their progress to make sure that they are on the right track. With that advisors are able to view student information given a student id, advisors can also view students requests and how many are pending, accepted, or rejected. Advisors are also tasked with helping students find the best referrers and companies for students to have the best chance at receiving a referral, with that advisors are able to view the top companies that give out the most referrals and they can view individual referrers who haven’t given out many referrals so they have plenty left. Advisor can also message a student and set a follow up date to make sure they are progressing.
As a referral giver, you can offer students referrals. You can view and manage all job or internship requests, access detailed student profiles, and review applications tied to specific opportunities. Additionally, referrers have tools to manage associated companies, update application statuses, and create or manage communication connections between students and organizations. You also maintain control over their own contact information, ensuring accuracy for smooth interactions.
| Technology | Version |
|---|---|
| Programming Language | Python 3.9 |
| Framework | Streamlit & Flask |
| Database | mySQL |
| Containerization | Docker |
-
Clone the Repository:
git clone https://github.com/your-username/your-project.git cd your-project -
Install Dependencies:
Follow specific commands to install required dependencies.pip install -r requirements.txt
-
Setup Environment Variables:
Refer to Environment Variables & Secrets.
-
Build the Docker Image:
docker-compose build
-
Run the Containers:
docker compose up -d
-
Access the Application:
Visithttp://localhost:8501in your browser.
List all required secrets and their purposes.
| Key | Description | Example |
|---|---|---|
DB_PASSWORD |
Database password | your_db_password |
SECRET_KEY |
Application secret key | random-string |
- Create a
.envfile at the root of the project. - Add your environment variables:
DB_PASSWORD=your_db_password SECRET_KEY=random-string
- Fork the repository.
- Create a new feature branch:
git checkout -b feature-name
- Commit changes:
git commit -m "Added a new feature" - Push the branch:
git push origin feature-name
- Open a Pull Request.
| Name | |
|---|---|
| Shireen Kumar | [email protected] |
| Sheryl Cheng | [email protected] |
| Isha Sakamuri | [email protected] |
| Yicheng Wang | [email protected] |
| Andreas Seferian | [email protected] |
This project is licensed under the MIT License. See LICENSE file for details.
For questions or issues, reach out to Database Dream Team at:
- Email: [email protected]
- GitHub Issues: GitHub Issues Page