Start Forging your CV with our AI Assisted Service

Visit Site

Table of Contents

1. About The Project
2. Stack
3. Architecture Diagram
4. Setup
5. Usage
6. Features
7. Contributing
8. License
9. Contact Us

About The Project

CVForge.ai is a SaaS that helps users create a CV suitable for the position they want to apply for with the help of AI. This application uses our database to search for CVs that were accepted for the desired position by the user and utilizes the information provided by the user via uploading their CV, linking their LinkedIn account, or entering their information manually. CVForge.ai uses artificial intelligence to generate a CV tailored to the specific position the user wishes to apply for. Additionally, it provides feedback on the generated CV, helping the user improve their presentation. GPT and LinkedIn APIs are used.

Stack

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Architecture Diagram

Diagram of Used Technologies

Setup

Prerequisites

Have Node installed on your hardware. To verify Node is installed, run the following command in your terminal:

npm -v

Installation

To install the project, follow these steps:

Clone the repository

git clone https://github.com/wizelineacademy/itesm-socioformador-feb-jun-2024-CVForge.git
cd itesm-socioformador-feb-jun-2024-CVForge

Install all dependencies

npm i

Create .env

Create a .env file in the root of the project and add the following environment variables.

AUTH_SECRET=<YOUR_KEY>
POSTGRES_URL=<YOUR_KEY>
DATABASE_URL=<your_database_url>
GOOGLE_CLIENT_ID=<your_google_client_id>
GOOGLE_CLIENT_SECRET=<your_google_client_secret>
NEXTAUTH_URL=<your_nextauth_url>
NEXTAUTH_SECRET=<your_nextauth_secret>
JWT_SECRET=<your_jwt_secret>
OPENAI_API_KEY=<your_openai_api_key>
NODE_TLS_REJECT_UNAUTHORIZED=<value> # e.g., 0
NEXT_PUBLIC_TINYMCE_API_KEY=<your_tinymce_api_key>
LINKEDIN_CLIENT_ID=<your_linkedin_client_id>
LINKEDIN_CLIENT_SECRET=<your_linkedin_client_secret>

(back to top)

Usage

To start the development server, run:

npm run dev

Features

• AI-assisted CV generation
• Integration with LinkedIn
• Feedback on CV quality
• Database of successful CVs for reference
• Secure user data management

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact Us

LinkedIn: CVForge

Project Link: https://github.com/wizelineacademy/itesm-socioformador-feb-jun-2024-CVForge

(back to top)

Contributors

We want to extend a big thank you to all of our contributors. Your support and contributions make this project possible!

@Lebrijay02	@marcopod	@Peco1503
@AngelGaelGarciaRangel	@YuvanTec	@a01721732

(back to top)