README.MD

Restful API for Resume (CV) Builder

• Front-End Web By @Mulyana
  
• Swagger Documentation

About

This is a Restful API for building resumes (CVs). For an example of a frontend web repository that uses this project, you can visit this repository made by @mmulyana. He created that frontend project using ReactJS, TypeScript, React Query, etc.

This RESTful API was developed within 3 days, so please understand if some features are not fully mature or if there are any bugs. However, after integration with the frontend, no bugs have been found so far. Please feel free to create an issue if you encounter any bugs.

Tech Stack

The RESTful API is built using Spring Boot. The technologies used in this project are as follows:

• Spring Boot (Spring Boot 3.3.1 with Java 21)
  • Spring Data JPA
  • Spring Web
  • Spring Security
  • jjwt
  • jaxb-api
  • etc
• Maven
• PostgreeSQL DBMS

Server Tech Stack : Nginx, Ubuntu, Docker, Certbot

Feature

The MVP features we have agreed upon to ensure the application functions properly are as follows:

• Login & register
• Add, edit, delete resume
• Publish resume
• Show available skills

Example

For an overview of the resume API, you can see one of the examples below. For complete details and other endpoint, please check the Swagger Documentation.

• Method : GET

• Endpoint : /resume/publish/{id}

• Example Result :

  {
    "data": {
      "id": 0,
      "design": "string",
      "name": "string",
      "photo": "string",
      "description": "string",
      "address": "string",
      "contact": {
        "email": "string",
        "portofolioWeb": "string",
        "linkedin": "string",
        "phone": "string"
      },
      "experience": [
        {
          "title": "string",
          "company": "string",
          "description": "string",
          "startDate": "2024-07-24",
          "endDate": "2024-07-24",
          "link": "string"
        }
      ],
      "education": [
        {
          "title": "string",
          "school": "string",
          "description": "string",
          "startDate": "2024-07-24",
          "endDate": "2024-07-24"
        }
      ],
      "portofolio": [
        {
          "title": "string",
          "role": "string",
          "description": "string",
          "startDate": "2024-07-24",
          "endDate": "2024-07-24",
          "link": "string"
        }
      ],
      "skills": [
        {
          "idSkill": 0,
          "name": "string",
          "image": "string"
        }
      ]
    },
    "error": "string"
  }