Skip to content

ItsRoy69/FLinQ

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome to FLINQ!

FlinQ-Banner-png

This project provides a one-stop platform for women facing gender inequality to access safe, empowering resources and connect with diverse professionals, both anonymously and in one-on-one settings.

Key Features:

  • Connect with experts: Choose between anonymous or one-on-one chat with professionals for guidance in healthcare, education, and career development.
  • Skill and career development: Access opportunities like Google STEP and Women Techmakers, along with skill-building events and workshops.
  • Reliable health information: Combat stigma and get reliable information from healthcare professionals.
  • Chatbot: Get instant answers to questions about beauty, health, fitness through our friendly and informative chatbot.
  • Emergency alerts: Stay safe with an alert system that empowers you in critical situations.
  • Community building: Share experiences and connect with other women through a dedicated feed page.
  • Job opportunities: Find your dream career with curated postings on the FlinQ jobs page.
  • Local resources: Easily locate nearby pharmacies, education institutes, and other essential services through the interactive map.

By dismantling barriers and fostering connections, FlinQ aims to create a safer and more empowered world for all women, offering both anonymity and the opportunity for deeper engagement.

User Workflow:

FlinQ-user-workflow-1

FlinQ-user-workflow-2

Folder Workflow:

├── chatbot/
├── client/
│   ├── public/
│   │   ├── icons/
│   ├── src/
│   │   ├── api/
│   │   ├── assets/
│   │   ├── components/
│   │   │   ├── alert/
│   │   │   ├── auth/
│   │   │   ├── chat/
│   │   │   ├── event/
│   │   │   ├── feed/
│   │   │   ├── jobs/
│   │   │   ├── navbar/
│   │   │   └── profile/
│   │   ├── constants/
│   │   │   ├── alert/
│   │   │   ├── feed-selector/
│   │   │   ├── home_navbar/
│   │   │   └── navbar/
│   │   │   └── search/
│   │   ├── contexts/
│   │   ├── data/
│   │   ├── pages/
│   │   │   ├── chat/
│   │   │   │   ├── anonymous/
│   │   │   │   ├── bot/
│   │   │   │   └── community/
│   │   │   ├── error/
│   │   │   ├── events/
│   │   │   ├── feed/
│   │   │   ├── home/
│   │   │   ├── jobs/
│   │   │   ├── map/
│   │   │   ├── profile/
│   │   │   └── user/
│   └── package.json
├── server/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   ├── config/
│   ├── middleware/
│   ├── services/
│   └── package.json
└── README.md

TECHSTACK

React JS TailwindCSS Express.js NodeJS MongoDB Vercel Onrender Firebase Socket.IO Python Flask Vertex AI PaLM Google Auth Google Maps Auth0

INSTALLATION

Clone this repository to your local machine.

git clone https://github.com/ItsRoy69/FLinQ
  • Chatbot Installation

    1. Navigate to the project directory.
    cd FlinQ
    cd chatbot
    1. Create a virtual environment:
    python -m venv venv
    1. Activate the virtual environment:

      Windows:

      venv\Scripts\Activate.ps1

      MacOS/ Linux:

      source venv/bin/activate
    2. Install dependencies:

      pip install -r requirements.txt
    3. Run the chatbot:

      Make sure you have a GCP account with Vertex AI enabled.

    python chat-flask.py
  • Client Installation

    1. Navigate to the project directory.
    cd FlinQ
    cd client
    1. Install dependencies.
    npm install
  • Server Installation

    1. Navigate to the project directory.
    cd FlinQ
    cd server
    1. Install dependencies.
    npm install
    1. Start the server:
    nodemon start

Running the App

Start the frontend application.

npm run dev
  • NOTE:

    Rename env.example in the client folder to .env and fill it with the required values. Refer to the .env.example file for guidance.

Don't let gender inequality hold you back. Take control, join the growing network of women and professionals on FlinQ and rewrite your story.