plxnner/README.md

An elegant open-source planner for Instagram

<a href="https://dxlliv.github.io/planner/docs/">
  <img src="https://raw.githubusercontent.com/dxlliv/planner/main/src/public/app/githubImage.webp" />
</a>

<h1 align="center">Instagram Planner</h1>

<p align="center">An elegant multifunctional open source planner for your Instagram profile</p>
<p align="center">
  <a href="https://github.com/dxlliv/planner"><img src="https://img.shields.io/github/v/release/dxlliv/planner?colorA=blue&colorB=212121" /></a>
  <a href="https://npmjs.com/package/plxnner"><img src="https://img.shields.io/npm/v/plxnner.svg?colorA=blue&colorB=212121" /></a>
  <a href="https://npmjs.com/package/plxnner"><img src="https://img.shields.io/npm/dm/plxnner.svg?colorA=41b883&colorB=212121" /></a>
  <a href="https://dxlliv.github.io/planner"><img src="https://img.shields.io/badge/demo-212121?label=planner&labelColor=41b883" /></a>
  <a href="https://github.com/dxlliv/planner"><img src="https://img.shields.io/github/stars/dxlliv/planner?style=social" /></a>
</p>

## About

**dxlliv/planner** lets you preview what your profile grid will look like.  
Plan the grid with no hassle and build your definitive Instagram profile.

**[Demo](https://dxlliv.github.io/planner/) · [Documentation](https://dxlliv.github.io/planner/docs/) · [Support](https://github.com/sponsors/dxlliv)**

## Features
- **Organize your grid**  
  Drag and drop your media or configure it in the old-fashioned way.


- **Plan your everything**  
  You will be able to plan posts, reels and highlights<sup>soon</sup> in a while.


- **A wide range of media**  
  It supports both local and remote images, videos, albums and iframes.


- **Limitless changes**  
  Edit your media as much as you want and build your definitive grid.


- **Backup your account**  
  It can serve as a planner but also as a backup for all of your content.


- **High quality media**  
  Avoid compression and deliver your work without annoying limits.


- **Host it anywhere**  
  Take ownership of your data, put your files in a repository and deploy.


- **Infinite possibilities**  
  Make your profile memorable and more indexable by search engines.


## Getting started

Make sure you have Node.js and Npm installed, then open your terminal.  
Run this command to generate a **dxlliv/planner** instance from scratch:

```bash
npx create-plxnner planner
```
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/dxlliv/planner?file=src%2Fpublic%2Fuser%2Finstagram%2Fdxlliv%2Fconfig.json)

### Configuration

You can update your profile by editing the file located at `src/public/user/instagram/{username}`.  
Update `planner.config.ts` accordingly. Read the [documentation](https://dxlliv.github.io/planner/docs/) for further information.

### Interactive Planning

You might like to plan your profile directly using a simple user interface.  
In that case, just upload the media and rearrange your grid as desired.

Then export your changes as a zip file and overwrite the existing profile.