38 lines
No EOL
1.6 KiB
Markdown
38 lines
No EOL
1.6 KiB
Markdown
# CVGen Project
|
|
|
|
## Overview
|
|
CVGen is a Node.js application that connects to the LinkedIn API to retrieve user profile information. The application is designed to display this information on a blank page without the need for HTML or CSS.
|
|
|
|
## Project Structure
|
|
```
|
|
cvgen
|
|
├── controllers
|
|
│ └── linkedin.js # Handles LinkedIn API connection and user profile retrieval
|
|
├── routes
|
|
│ ├── api.routes.js # Defines API routes for LinkedIn authentication and data fetching
|
|
│ └── front.routes.js # Defines front-end routes (currently not utilized)
|
|
├── views # Currently empty, not needed for this project
|
|
├── public
|
|
│ └── img # Contains images (not utilized in this project)
|
|
├── app.js # Entry point of the application, sets up server and routes
|
|
├── package.json # Configuration file for npm, lists project dependencies
|
|
└── README.md # Documentation for the project
|
|
```
|
|
|
|
## Setup Instructions
|
|
1. Clone the repository to your local machine.
|
|
2. Navigate to the project directory.
|
|
3. Run `npm install` to install the required dependencies.
|
|
4. Configure your LinkedIn API credentials in the `linkedin.js` controller.
|
|
5. Start the application by running `node app.js`.
|
|
|
|
## Usage
|
|
- The application will connect to the LinkedIn API and retrieve user profile information.
|
|
- The retrieved information will be displayed on a blank page.
|
|
|
|
## Dependencies
|
|
- Express: A web framework for Node.js.
|
|
- LinkedIn API libraries: For connecting and interacting with the LinkedIn API.
|
|
|
|
## License
|
|
This project is licensed under the MIT License. |