Skip to content

Latest commit

 

History

History
76 lines (49 loc) · 2.16 KB

ReadME.md

File metadata and controls

76 lines (49 loc) · 2.16 KB

Portals

Live link: https://portals3.onrender.com

Motivation

My friends and I were in spots that could define our careers - we know what we want to be but how do we get there. We quickly realized that most "roadmaps" are generalized, comprehensive and as a result, overwhelming.

We decided to use AI to build something simpler - personalized to you, what you have learnt/done in the past and what you want to become.

Overview

Portals makes it easier to get started in tech as a beginner by generating a personalized roadmap containing quality resources for you.

  • You log in using Google Authentication
  • You fill a multi-page form that helps us understand you, what you have done in the past and your current career goal
  • You sit back and see in <2 minutes your personalized roadmap with quality resources.

Demo

Demo of Portals

Tech Stack

  • React - Frontend framework
  • Vanilla CSS - Styling the page
  • Firebase Cloud Filestore - Database for storage of user details and roadmap
  • Flask - Backend framework
  • OpenAI API - API for generating the roadmap
  • React-Chrono - Library for converting the roadmap into a timeline
  • Railway - Deployment service

Architecture

Architecture of Portals

Development Setup

  1. Clone the repo
$ git clone https://github.com/hemjay07/Portals.git portals
$ cd portals
  1. Install the dependencies:
$ pip install -r requirements.txt
  1. Put your OpenAI key in app.py
 openai.api_key = your_key
  1. Run the development server:
$ python app.py
  1. Navigate to the Home page http://127.0.0.1:5000

Potential Additional Features

  1. Write tests for the app
  2. Add feature to download a PDF version of the roadmap
  3. Add feature for users to receive push notifications when the deadline of completing one course is done

Collaborators