https://github.com/exposedcat/insta-formatter

Image formatter for Instagram [API]
https://github.com/exposedcat/insta-formatter

Last synced: 3 months ago
JSON representation

Image formatter for Instagram [API]

• Host: GitHub
• URL: https://github.com/exposedcat/insta-formatter
• Owner: ExposedCat
• Created: 2022-07-23T10:05:44.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-07-27T11:12:56.000Z (over 3 years ago)
• Last Synced: 2025-01-18T14:34:17.627Z (12 months ago)
• Language: TypeScript
• Size: 2.62 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


    
Instagram Posts Formatter




![](https://img.shields.io/badge/Telegram-Developer-informational?style=for-the-badge&logo=telegram&logoColor=26A5E4&color=26A5E4)





![](https://img.shields.io/badge/Reddit-Developer-informational?style=for-the-badge&logo=reddit&logoColor=FF5700&color=FF5700)





![](https://img.shields.io/badge/Swagger-Docs-green?style=for-the-badge&logo=swagger)









    
⭐️ Features





    
Portrait, Landscape and Standard posts support

    
Using image dominant color as the background for the gaps

    
Convenient for frontend usage

    
Strict code formatting rules

    
Scalable file architecture

    
100% of API is documented



    
Well-readable git repository with a beautiful README :з





    
💼 TODO





    
Write API documentation

    
Add option to specify custom aspect ratio

    
Delete images after formatting





    
⚙️ Stack





    
Programming language: Node.JS

    
API: Express.JS

    
Running tools: Docker

    
Documentation: Swagger





    
🔌 Running





    
via pure Node.JS



1. Clone this repo:

```bash

git clone https://github.com/ExposedCat/insta-formatter.git

```

2. Go to the project root:

```bash

cd insta-formatter

```

3. Create copy of `.env-example` called `.env` and replace example data with yours

4. Start app (specify name of the config created before):

```bash

CONFIG='.env' npm start

```



    
via Docker/Podman



0. Install [Docker](https://docs.docker.com/get-docker/) or [Podman](https://podman.io/getting-started/installation)

1. Clone this repo:

```bash

git clone https://github.com/ExposedCat/insta-formatter.git

```

2. Go to project root:

```bash

cd insta-formatter

```

3. Create copy of `.env-example` called `.env` and replace example data with yours

4. Build app image:

```bash

docker build -t insta-formatter-api .

```

or

```bash

podman build -t insta-formatter-api .

```

5. Start app:

```bash

docker-copmpose up -d

```

or

```bash

podman-copmpose up -d

```

**Done**.



    
via Nodemon

    
for development



0. Install and run MongoDB server

1. Clone this repo:

```bash

git clone https://github.com/ExposedCat/insta-formatter.git

```

2. Go to project root:

```bash

cd insta-formatter

```

3. Create copy of `.env-example` and replace example data with yours

4. Install dependencies:

```bash

npm install

```

5. Start app (specify name of the config created before):

```bash

CONFIG='.env' npm run dev

```

**Done**.



    
🔩 Dependencies



Production



    
Express.JS

    
DotEnv

    
Helmet

    
UUID



Development



    
Nodemon

    
Prettier