https://github.com/jovanyaldair/pdf-api-node

https://github.com/jovanyaldair/pdf-api-node

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/jovanyaldair/pdf-api-node
• Owner: JovanyAldair
• Created: 2023-11-17T20:38:07.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-07-07T20:01:48.000Z (6 months ago)
• Last Synced: 2024-07-08T21:34:43.497Z (6 months ago)
• Language: JavaScript
• Size: 5.31 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Node.js API to download a PDF file

## Introduction

This project consists of an API made in Node.js, which will download a PDF file, called `file.pdf`

in which I set up a unit test using Node.js `supertest` package and did continuous integration **CI** using `Github Actions`

## Tools used in this project

[Node.js](https://nodejs.org/en)

[Express.js](https://expressjs.com/)

[supertest.js](https://www.npmjs.com/package/supertest)

[Github Actions](https://github.com/features/actions)

## Usage

To use this project, firstly, download the project to your PC runing the command:

`git clone [email protected]:JovanyAldair/pdf-api-node.git`

make sure you have node.js installed on your machine, and running the command:

`npm install`

Run the tests firstly using the command:

`npm test`

Finally run the application running the command:

`npm start`

Test the application typing on your browser:

`localhost:3000/download`

It will dowdload the **file.pdf**