-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
74 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2021 Deki | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,73 +1,74 @@ | ||
| <p align="center"> | ||
| <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo_text.svg" width="320" alt="Nest Logo" /></a> | ||
| </p> | ||
|
|
||
| [circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456 | ||
| [circleci-url]: https://circleci.com/gh/nestjs/nest | ||
|
|
||
| <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p> | ||
| <p align="center"> | ||
| <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a> | ||
| <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a> | ||
| <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a> | ||
| <a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a> | ||
| <a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a> | ||
| <a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a> | ||
| <a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a> | ||
| <a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a> | ||
| <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a> | ||
| <a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a> | ||
| <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a> | ||
| </p> | ||
| <!--[](https://opencollective.com/nest#backer) | ||
| [](https://opencollective.com/nest#sponsor)--> | ||
|
|
||
| ## Description | ||
|
|
||
| [Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. | ||
| # Image Optimizer Backend | ||
|
|
||
| Image Optimizer Backend is a application for [image optimizer frontend](https://github.com/dekiakbar/image-optimizer-fe). Build by [Nest Js](https://nestjs.com/) | ||
|
|
||
| ## Installation | ||
|
|
||
| this project created use the following tool | ||
| > node version : v16.6.1 | ||
| > npm version : 7.20.5 | ||
| ### Backend (this repo) | ||
|
|
||
| Clone this repository | ||
|
|
||
| ```bash | ||
| $ npm install | ||
| git clone https://github.com/dekiakbar/image-optimizer | ||
| ``` | ||
|
|
||
| ## Running the app | ||
| Navigate to project dir | ||
|
|
||
| ```bash | ||
| # development | ||
| $ npm run start | ||
| cd image-optimizer | ||
| ``` | ||
|
|
||
| # watch mode | ||
| $ npm run start:dev | ||
| Install node modules and dependencies | ||
|
|
||
| # production mode | ||
| $ npm run start:prod | ||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| ## Test | ||
| ### Frontend Clone this repository | ||
|
|
||
| You must install [image optimizer Frontend](https://github.com/dekiakbar/image-optimizer-fe). | ||
|
|
||
| ## Environment Variable | ||
|
|
||
| Copy `env.example` to `.env` | ||
|
|
||
| ```bash | ||
| cp .env.example .env | ||
| ``` | ||
|
|
||
| Fill the required `env` variables: | ||
| > note: get Imagekit key from [Imagekit.io](https://imagekit.io/) | ||
| ```bash | ||
| # unit tests | ||
| $ npm run test | ||
| PORT=3000 | ||
|
|
||
| # e2e tests | ||
| $ npm run test:e2e | ||
| IMAGEKIT_PUBLIC_KEY=<YOUR_IMAGEKIT_PUBLIC_KEY> | ||
| IMAGEKIT_PRIVATE_KEY=<YOUR_IMAGEKIT_PRIVATE_KEY> | ||
| URL_ENDPOINT=<YOUR_IMAGEKIT_ENDPOINT> | ||
|
|
||
| # test coverage | ||
| $ npm run test:cov | ||
| # separated by space and please provide (dot) before list the extension | ||
| ALLOWED_FILE_TYPE=.jpeg .jpg .png | ||
| MAX_FILE_UPLOAD=5 | ||
| # max upload size in KB | ||
| MAX_UPLOAD_SIZE=8192 | ||
| ``` | ||
|
|
||
| ## Support | ||
| ## Running the app | ||
|
|
||
| Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support). | ||
| ```bash | ||
| # development | ||
| $ npm run start | ||
|
|
||
| ## Stay in touch | ||
| # watch mode | ||
| $ npm run start:dev | ||
|
|
||
| - Author - [Kamil Myśliwiec](https://kamilmysliwiec.com) | ||
| - Website - [https://nestjs.com](https://nestjs.com/) | ||
| - Twitter - [@nestframework](https://twitter.com/nestframework) | ||
| # production mode | ||
| $ npm run start:prod | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| Nest is [MIT licensed](LICENSE). | ||
| [MIT](https://github.com/git/git-scm.com/blob/main/MIT-LICENSE.txt) |