Giter Club home page Giter Club logo

react-image-compressor's Introduction

React Image Compressor

What it does

  • Compress Image By Reducing Resolution and Size
  • Save original and compressed files to S3
  • Contains Custom APIs to fetching saved files

A simple image compressor built with react, next.js and browser-image-compression

Built With

  • ReactJS
  • Next.js
  • React Bootstrap
  • Browser Image Compression

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Need to install a software below to run the project on your local machine:

Development

  1. Clone the repository and change directory.
git clone https://github.com/Mariam13/react-image-compressor
cd react-image-compressor
  1. Install npm dependencies
npm install
  1. To allow S3 uploading you should create a local environment file in the main directory and add all necessary configs to connect AWS Bucket

So, to create a local environment file run the following command on terminal

touch .env.local

After you should fill this AWS configurations

AWS_S3_BUCKET_NAME_ID=
AWS_S3_ACCESS_KEY_ID=
AWS_S3_SECRET_ACCESS_KEY=
  1. Run the app locally.
npm run dev

By default it will run on http://localhost:3000 server

If you want to build the app use "npm run build" command

Postman collection

You can find all the available APIs on this postman collection (click here)

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.