ResumeProject

Welcome to the ResumeProject GitHub repository! This project is designed to help users create and manage their resumes online. It utilizes Django as the backend framework and Bootstrap 5 for the user interface. The app provides features such as user authentication, resume creation forms, and the ability to convert resumes to PDF format using wkhtmltopdf.

Features

• User Authentication: Users can register and log in securely to create and manage their resumes.

• Bootstrap 5 UI: The user interface is designed using Bootstrap 5, ensuring a responsive and modern design.

• Resume Creation: Users can fill in details about their education, work experience, skills, and more using interactive forms.

• PDF Conversion: Resumes can be converted to PDF format using the wkhtmltopdf tool, providing a downloadable and printable version.

Requirements

Make sure you have the following dependencies installed before running the app:

pip install -r requirements.txt

The requirements.txt file contains the necessary Python packages and versions.

Getting Started

Follow these steps to get the project up and running on your local machine:

1. Clone this repository:

git clone https://github.com/akinolaemmanuel49/resumeproject.git
cd resumeproject

2. Create a virtual environment (recommended) and activate it:

python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install the project dependencies:

pip install -r requirements.txt

4. Apply migrations to set up the database:

python manage.py migrate

5. Create a superuser account for admin access:

python manage.py createsuperuser

6. Add the .env file and place it in the root directory, you can use the .env.example file for guidance or set the environment variables:

SECRET_KEY="secret-key"
EMAIL_HOST="smtp.provider.com"
EMAIL_HOST_USER="example.mail.com"
EMAIL_HOST_PASSWORD="password"
EMAIL_PORT= 587
EMAIL_USE_TLS=True
DEFAULT_FROM_EMAIL="[email protected]"

7. Run the development server:

python manage.py runserver

8. Open a web browser and navigate to http://127.0.0.1:8000 to access the app.

Running Tests

This repository includes test cases to ensure the functionality of the app. To run the tests, use the following command:

python manage.py test

Installing wkhtmltopdf

To install wkhtmltopdf, you can follow the instructions for your specific operating system. wkhtmltopdf is a command-line tool that converts HTML and CSS into PDF files. Here's how you can install it on various operating systems:

Linux (Ubuntu/Debian):

You can install wkhtmltopdf on Ubuntu/Debian using the following commands:

sudo apt-get update
sudo apt-get install wkhtmltopdf

Windows:

To install wkhtmltopdf on Windows, you can download the precompiled binary from the official website: https://wkhtmltopdf.org/downloads.html

Choose the appropriate installer for your system (32-bit or 64-bit), download it, and run the installer to install wkhtmltopdf on your Windows machine.

After installation, you should be able to use wkhtmltopdf from the command line to convert HTML to PDF.

To test if wkhtmltopdf is installed correctly, open your terminal or command prompt and run:

wkhtmltopdf --version

This command should display the version information if wkhtmltopdf is installed successfully.

This command will execute the test suite and provide you with information about the tests' success.

Feel free to explore the app's features, create resumes, and generate PDFs of your resumes!

If you encounter any issues or have questions, please don't hesitate to open an issue on this repository. Happy coding!

Note:

This project has only been tested on a Windows Operating System (Windows 10). The workflow to implement it on a UNIX based machine will be different.