Mokshith commited on
Commit
6cd6d7f
Β·
1 Parent(s): 5da6b77

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +8 -118
README.md CHANGED
@@ -1,118 +1,8 @@
1
- # Resume Generator API using AdobePdfServices SDK
2
-
3
- This is a Node.js API for generating professional resumes using the AdobePdfServices SDK. It allows users to create resumes by sending a POST request with the required information and generates a PDF document based on the provided data.
4
-
5
- ## File Structure
6
-
7
- The file structure of the project is organized as follows:
8
-
9
- ```
10
- β”œβ”€β”€ __tests__
11
- β”‚ β”œβ”€β”€ resume-invalid-json.test.js
12
- β”‚ β”œβ”€β”€ resume-internal-server-error.test.js
13
- β”‚ β”œβ”€β”€ resume-success.test.js
14
- β”‚ β”œβ”€β”€ resume-template-not-found.test.js
15
- β”‚ └── resume-unauthorized.test.js
16
- β”œβ”€β”€ node_modules
17
- β”œβ”€β”€ public
18
- β”‚ β”œβ”€β”€ images
19
- β”‚ β”‚ β”œβ”€β”€ BasicTemplatePhoto.jpg
20
- β”‚ β”‚ β”œβ”€β”€ ImageTemplatePhoto.jpg
21
- β”‚ β”‚ └── LinkTemplatePhoto.jpg
22
- β”‚ β”œβ”€β”€ script.js
23
- β”‚ └── styles.css
24
- β”œβ”€β”€ routers
25
- β”‚ β”œβ”€β”€ resume.js
26
- β”‚ └── views.js
27
- β”œβ”€β”€ src
28
- β”‚ β”œβ”€β”€ api-app.js
29
- β”‚ β”œβ”€β”€ constants.js
30
- β”‚ β”œβ”€β”€ pdf.js
31
- β”‚ β”œβ”€β”€ server.js
32
- β”‚ β”œβ”€β”€ validation.js
33
- β”‚ └── view-app.js
34
- β”œβ”€β”€ temp
35
- β”œβ”€β”€ Templates(Templates Data)
36
- β”œβ”€β”€ views
37
- β”‚ └── form.ejs
38
- β”œβ”€β”€ .gitignore
39
- β”œβ”€β”€ certificate_pub.crt
40
- β”œβ”€β”€ LICENSE
41
- β”œβ”€β”€ package-lock.json
42
- β”œβ”€β”€ package.json
43
- β”œβ”€β”€ pdfservices-api-credentials.json
44
- β”œβ”€β”€ private.key
45
- └── README.md
46
- ```
47
-
48
- ## Setup
49
-
50
- To set up the API, follow these steps:
51
-
52
- 1. Set up AdobePdfServices credentials by following the instructions in [Adobe's Document Generation API Quickstarts for Node.js](https://developer.adobe.com/document-services/docs/overview/document-generation-api/quickstarts/nodejs/).
53
-
54
- 2. Install the application's dependencies by running the command:
55
-
56
- ```shell
57
- npm i
58
- ```
59
-
60
-
61
- 3. Place the `pdfservices-api-credentials.json` file in the root folder of the project.
62
- set the env variables
63
-
64
- **Windows (CMD):**
65
- ```shell
66
- set PDF_SERVICES_CLIENT_ID=<YOUR_CLIENT_ID>
67
- set PDF_SERVICES_CLIENT_SECRET=<YOUR_CLIENT_SECRET>
68
- ```
69
-
70
- **MacOS/Linux:**
71
- ```shell
72
- export PDF_SERVICES_CLIENT_ID=<YOUR_CLIENT_ID>
73
- export PDF_SERVICES_CLIENT_SECRET=<YOUR_CLIENT_SECRET>
74
- ```
75
- .
76
- ## Technologies Used
77
-
78
- The technologies used in this API are:
79
-
80
- - Jest: A JavaScript testing framework.
81
- - EJS: A templating engine for generating HTML markup with JavaScript.
82
- - Express: A web application framework for Node.js.
83
- - AdobePdfServices SDK: A software development kit for interacting with Adobe's PDF services.
84
-
85
-
86
- ## API Endpoints
87
-
88
- The API provides the following endpoint:
89
-
90
- - `POST /resume`: Generates a resume in PDF format based on the provided data.
91
-
92
- ## Usage
93
-
94
- To use the API:
95
-
96
- 1. Start the API server by running the command:
97
-
98
- ```shell
99
- npm run dev
100
- ```
101
-
102
- 2. Send a POST request to `http://localhost:8080/resume` with the necessary data in the request body to generate a resume in PDF format and
103
- the view is hosted at `http://localhost:3000`
104
-
105
-
106
- ## Unit Testing
107
-
108
- To run the unit tests and view the results, use the command:
109
-
110
- ```shell
111
- npm test
112
- ```
113
- Conducted unit tests over 77 cases and 5 test suites
114
- ## License
115
-
116
- This project is licensed under the [MIT License](LICENSE).
117
-
118
- Feel free to explore and modify the API according to your needs!
 
1
+ ---
2
+ title: Basic Docker SDK Space
3
+ emoji: 🐳
4
+ colorFrom: purple
5
+ colorTo: gray
6
+ sdk: docker
7
+ app_port: 7860
8
+ ---