Giter Club home page Giter Club logo

image-processing-api's Introduction

Image processing API

This API is part of my training on UDACITY, and allows students to understand the development of APIs with ExpressJS.

The purpose of this application is to provide learners with the skills necessary to develop an Express API on a NodeJS environment.

The only functionality of the application is the processing of JPG images through URL

Getting started

To work with this project, you need to know JavaScript, TypeScript, ExpressJS and NodeJS.

Configuration for local development

Install depencies

This project was made with NodeJs v16.17.0 and npm 8.15.0

To install the dependencies, place yourself in the project folder and run the following command

npm install

Script details

  • start:dev to start local server for development
  • build to build project
  • lint to display ESLint issues
  • lint:fix to automatically fix ESLint issues
  • test to run project tests

To run the local server, execute:

npm run start:dev

Default URL should be http://127.0.0.1:3000/

Testing

Tests are not required to run the API. But if you contribute, please run the tests before pushing to GitHub. To run the tests, execute:

npm run test

Production

To build for production, execute:

npm run build

The outpout folder is dist

API Reference

Getting Started

Endpoints

Get health check

  GET /
  • General: returns home page with a simple description.
  • Sample: http://127.0.0.1:3000

Processing image

  GET /api/images
Parameter Type Description
filename string Required. File name on server
width string Required. desired width
height string Required. desired height
  • General: displays image with width and height provided.
  • Sample: http://127.0.0.1:3000/api/images?filename=encenadaport&width=300&height=400

Authors

Acknowledgements

image-processing-api's People

Contributors

fofana12 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.