Coder-KP commited on
Commit
e689e0a
Β·
verified Β·
1 Parent(s): f82f64c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +84 -5
README.md CHANGED
@@ -1,8 +1,10 @@
1
  ---
2
  title: SmartContent Studio
3
- emoji: πŸš€
4
  colorFrom: red
5
  colorTo: red
 
 
6
  sdk: docker
7
  app_port: 8501
8
  tags:
@@ -11,9 +13,86 @@ pinned: false
11
  short_description: Streamlit template space
12
  ---
13
 
14
- # Welcome to Streamlit!
15
 
16
- Edit `/src/streamlit_app.py` to customize this app to your heart's desire. :heart:
17
 
18
- If you have any questions, checkout our [documentation](https://docs.streamlit.io) and [community
19
- forums](https://discuss.streamlit.io).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: SmartContent Studio
3
+ emoji: πŸ“„
4
  colorFrom: red
5
  colorTo: red
6
+ # colorFrom: blue
7
+ # colorTo: green
8
  sdk: docker
9
  app_port: 8501
10
  tags:
 
13
  short_description: Streamlit template space
14
  ---
15
 
16
+ # SmartResume Generator
17
 
18
+ SmartResume Generator is an AI-powered platform designed to simplify resume creation. Using generative AI technology, this tool creates professional, tailored resumes based on user inputs. With multiple customizable templates and the ability to generate resumes in PDF and DOCX formats, users can save time, reduce stress, and ensure their resumes stand out in job applications.
19
 
20
+ ---
21
+
22
+ ## Features
23
+
24
+ - **Generative AI for Resume Creation**: Automatically generates high-quality resume content based on user-provided information and custom prompts.
25
+ - **Interactive User Interface**: A user-friendly platform built with Streamlit for easy navigation and data input.
26
+ - **Customizable Resume Templates**: Choose from a wide range of professional templates to match your style and industry.
27
+ - **Multi-Format Downloads**: Export resumes in both PDF and DOCX formats for flexibility and convenience.
28
+ - **Real-Time Progress Updates**: Visual progress indicator ensures a seamless user experience.
29
+ - **Secure Data Handling**: API keys and sensitive user inputs are securely managed using environment variables.
30
+
31
+ ---
32
+
33
+ ## Installation
34
+
35
+ To set up and run the SmartResume Generator locally, follow these steps:
36
+
37
+ 1. **Clone the Repository**:
38
+ ```bash
39
+ git clone https://github.com/your-repo/smartresume-generator.git
40
+ cd smartresume-generator
41
+
42
+ 2. **Install Dependencies: Ensure you have Python installed. Install the required libraries:**:
43
+ ```bash
44
+ pip install -r requirements.txt
45
+
46
+ 3. **Set Up Environment Variables**:
47
+ - Create a .env file in the root directory.
48
+ - Add your API key:
49
+ ```
50
+ API_KEY=your_google_generative_ai_api_key
51
+
52
+ 4. **Run the Application: Start the application locally using Streamlit**:
53
+ ```bash
54
+ streamlit run app.py
55
+
56
+ 5. **Access the Application**: Open your browser and navigate to
57
+ ```
58
+ [http://localhost:8501](http://localhost:8501)
59
+
60
+ ## Usage
61
+
62
+ 1. Enter personal details such as name, job title, and skills.
63
+
64
+ 2. Provide your professional and educational experience.
65
+
66
+ 3. Select a resume template from various available options.
67
+
68
+ 4. Input a custom prompt for additional customization.
69
+
70
+ 5. Click "Generate Resume" and review the generated content.
71
+
72
+ 6. Download your resume in PDF or DOCX format.
73
+
74
+ ## Technology Stack
75
+
76
+ - **Frontend**: Streamlit
77
+
78
+ - **Backend**: Python
79
+
80
+ - **AI Engine**: Google Generative AI (Gemini-1.5-pro)
81
+
82
+ - **Template Management**: Pre-designed HTML/CSS layouts
83
+
84
+ - **File Conversion**: pdfkit (PDF) and python-docx (DOCX)
85
+
86
+ ## Contribution
87
+
88
+ Contributions are welcome! Feel free to fork the repository, make changes, and submit a pull request.
89
+
90
+ ## Contact
91
+
92
+ For questions, suggestions, or feedback, please contact us at:
93
+
94
+ - **E-mail**: ```pkartikey5757@gmail.com
95
+
96
+ # Author
97
+
98
+ CoderKP