Instagram Posts Formatter

⭐️ 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:

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

2. Go to the project root:

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):

CONFIG='.env' npm start

via Docker/Podman

0. Install Docker or Podman
1. Clone this repo:

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

2. Go to project root:

cd insta-formatter

3. Create copy of .env-example called .env and replace example data with yours
4. Build app image:

docker build -t insta-formatter-api .

or

podman build -t insta-formatter-api .

5. Start app:

docker-copmpose up -d

or

podman-copmpose up -d

Done.

via Nodemon

for development

0. Install and run MongoDB server
1. Clone this repo:

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

2. Go to project root:

cd insta-formatter

3. Create copy of .env-example and replace example data with yours
4. Install dependencies:

npm install

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

CONFIG='.env' npm run dev

Done.

🔩 Dependencies

Production

• Express.JS
• DotEnv
• Helmet
• UUID

Development

• Nodemon
• Prettier