https://github.com/alexander784/resume-builder

A Resume Builder website
https://github.com/alexander784/resume-builder

flask-api flask-application restful-api sqlalchemy usecontext

Last synced: 10 months ago
JSON representation

A Resume Builder website

• Host: GitHub
• URL: https://github.com/alexander784/resume-builder
• Owner: alexander784
• Created: 2024-06-24T07:32:42.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-01-24T11:58:36.000Z (over 1 year ago)
• Last Synced: 2025-03-01T10:46:17.840Z (over 1 year ago)
• Topics: flask-api, flask-application, restful-api, sqlalchemy, usecontext
• Language: JavaScript
• Homepage:
• Size: 5.59 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
## Resume Builder

 A web app for creating resumes.Built with React for the frontend and Flask backend, this app allow user to  edit, preview your resume and download the  resume. 


## Features

 User Authentication: Secure login and registration using JWT.

Resume Editor: Create and customize resumes with sections like Education Experience,Skills

Preview and Download: Preview resumes in real time and dowbload them as PDF


# Demo:

  https://drive.google.com/file/d/1rgA6pcl4AD7HhorDwNEGrNK5riqxycDw/view?usp=sharing

## Getting Started with Rseume Builder

1. Clone the Repo: 


`git clone https://github.com/yourusername/resume-builder.git`

`cd resume-builder`

2. ## Backend Setup:

   
 Navigate to the server directory and create your virtual env


    `cd server` 


    `pipenv install && pipenv shell`

    
Install the required packages: 


    `pip install -r requirements.txt`

    
Setup your db:

    flask db init 


    `flask db migrate`


    `flask db upgrade`


3. ## Frontend Setup:

 
Navigate to the client DIR:


  `cd client` 


  `npm install`


  ## Running the App

  1. Start the backend server

        cd server 

        flask run 

  2. Start the frontend server

   

    `cd client`

    `npm start`

  3. Access your App: Open your browser and go to: 


    `http://localhost:3000/` 

## Usage

1. Signup: Create an account using your email and password.

2. Edit a Resume Template 

3. Preview and Downlaod: Review your resume and downlaod as PDF.

## API Documentation

## The API provides endpoints for user authentication, resume management, and more. 

 ## Detailed API documentation is available here:https://resume-builder-lrvo.onrender.com/

## Contributing 

 All Contributions are welcome! 

## License

This project is licensed under the MIT License - see the LICENSE file for details.

## Author 

 Alexander Nyaga.

 ## ga.nyaga7@gmail.com