ulisesalexanderam/my_portfolio_api

API that serves as the bridge between my future portfolio website and the database where all the information is saved.

My portfolio API previously known as Job Hunting Helper

This is a project to access a list of my skills and the projects related to them. The API serves as the bridge between my future portfolio website and the database where all information is saved. This API only can access the database, it can't modify it, to do operations in the database I'm planning to create a command line utility, probably with Typer.

Motivation

This project started as an app to keep track of my job applications, but as I was developing it I realized that I was more interested in keeping track of my skills and the projects related to them. So I decided to change the focus of the app. This forms the API of my portfolio. The front end will be in another repository.

Technologies used

• FastAPI
• Beanie to connect to MongoDB

Diagrams

Entity Relationship Diagram (ERD)

erDiagram
  Skills one or more -- one or more SkillsProjects : has
  Projects one or more -- one or more SkillsProjects : has
  Skills {
    objectId _id PK
    string name UK
    string description
  }
  Projects {
    objectID _id PK
    string name UK
    string description
  }
  SkillsProjects {
    objectId _id PK
    objectId skillsId FK
    objectId projectsId FK
  }

Loading

User stories

• 1 - Retrieve a skill As a person who wants to keep track of my skills, I want to retrieve a skill, so that I can see its details.

  Acceptance criteria:

  • I can retrieve a skill by its name
  • I can retrieve a skill's description
  • I can retrieve a skill's projects

• 2 - Retrieve all skills As a person who wants to keep track of my skills, I want to retrieve all skills, so that I can see all of them.

  Acceptance criteria:

  • I can retrieve all skills

• 3 - Retrieve a project As a person who wants to keep track of my skills, I want to retrieve a project, so that I can see its details.

  Acceptance criteria:

  • I can retrieve a project by its name
  • I can retrieve a project's description
  • I can retrieve a project's links
  • I can retrieve a project's skills

• 4 - Retrieve all projects As a person who wants to keep track of my skills, I want to retrieve all projects, so that I can see all of them.

  Acceptance criteria:

  • I can retrieve all projects

my_portfolio_api's Issues

Make a dataclass for skill

• Field name - Type str
• Field level - Type float

Retrieve skills

• Function to retrieve skills from the database.

Obtain job application/job or company of interest

• Function to ask for the job title of the job opening or job title desired.
• Function to ask for the application status.
• Function to ask for the date of application.
• Function to ask for the source of the job opening.
• Function to ask for the company name.
• Function to ask for the skills specific to the job.

Modify skill

• Function to edit skill name
• Function to update skill level
• Function to delete skill

Store skills

• Store skills in an SQLite database.
• Function to save the skill in the table

Database tables

• Function to create a table for the skills
• Function to create a table for the job openings/jobs or companies of interest.

Skills window

• Window that shows all the skills saved
• Button to add new skill
• Visual element to delete a skill
• Visual element to edit a skill
• Selection checkbox

Docs: Add explanation to configure DB

Add an explanation in the README for how to configure the SQLite database.

Retrieve job applications/jobs or companies of interest

• Function to retrieve the job title.
• Function to retrieve the application status.
• Function to retrieve the date of applications if exist.
• Function to retrieve the source of the job opening or the company of interest.
• Function to retrieve the company name.
• Function to retrieve the skills specific to the job opening.
• Function to retrieve the skill alignment indicator.

Create a data class for the job application/interest in a job or company

The data class must contain the following fields:

• Job title - Type str

• Application status - Enum:

  • Interesado (Spanish for interested)
  • Preparando/personalizando CV (Spanish for preparing/personalizing resume)
  • CV enviado/aplicacion iniciado (Spanish for resume sent/application initiated)
  • Agendando entrevista (Spanish for scheduling interview)
  • Entrevista agendada (Spanish for interview scheduled)
  • Rechazado (Spanish for rejected)
  • Aceptado (Spanish for aceppted)
  • Contrato firmado (Spanish for contract signed)
  • Onboarding

• Date of application (Optional) - Date object

• Source of the job opening or company of interest - Type str

• Company name - Type str

• Skills specific to the job opening - list of skills

• Skill alignment indicator - Type float

Obtain skill

• Function to ask for the skill name.
• Function to ask for the skill level.

Connection to database

• Function to connect to the database.
• Function to close the connection to the database.

Store job applications/jobs or company of interest

• Store job applications/jobs or companies of interest in an SQLite database.