mirror of
https://github.com/ergosteur/instaarchive-viewer.git
synced 2026-07-04 11:07:15 -04:00
docs: update README and GEMINI.md, remove AI Studio boilerplate and .env.example
This commit is contained in:
47
README.md
47
README.md
@@ -1,20 +1,43 @@
|
||||
<div align="center">
|
||||
<img width="1200" height="475" alt="GHBanner" src="https://github.com/user-attachments/assets/0aa67016-6eaf-458a-adb2-6e31a0763ed6" />
|
||||
</div>
|
||||
# InstaArchive Viewer
|
||||
|
||||
# Run and deploy your AI Studio app
|
||||
A high-performance React PWA for browsing archived Instagram data with a native-feeling interface. Supports both official Instagram exports and Instaloader archives.
|
||||
|
||||
This contains everything you need to run your app locally.
|
||||
## Features
|
||||
|
||||
View your app in AI Studio: https://ai.studio/apps/29dc2807-7763-419f-9f2f-ac644e1bf4a1
|
||||
- **Local Privacy**: All processing is done client-side using browser APIs. Your data never leaves your computer.
|
||||
- **Multiple Formats**: Supports official Instagram JSON exports and Instaloader regex-based naming conventions.
|
||||
- **Metadata Support**: Robust parsing of `.json` and `.json.xz` files for captions, timestamps, and story metadata.
|
||||
- **Story Viewer**: Native-like story experience with segmented progress bars, auto-playback, and audio controls.
|
||||
- **Media Grid**: Customizable 1:1 or 3:4 grid views with adjustable offsets for aesthetic alignment.
|
||||
- **Auto-Deduplication**: Intelligently prefers video files over thumbnail images for the same post.
|
||||
|
||||
## Run Locally
|
||||
|
||||
**Prerequisites:** Node.js
|
||||
**Prerequisites:** Node.js (LTS recommended)
|
||||
|
||||
1. **Install dependencies:**
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
1. Install dependencies:
|
||||
`npm install`
|
||||
2. Set the `GEMINI_API_KEY` in [.env.local](.env.local) to your Gemini API key
|
||||
3. Run the app:
|
||||
`npm run dev`
|
||||
2. **Start the development server:**
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
3. **Open in browser:**
|
||||
Navigate to `http://localhost:3000` and select your Instagram archive directory.
|
||||
|
||||
## Building for Production
|
||||
|
||||
To generate a production-ready build in the `dist` folder:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
To preview the build:
|
||||
|
||||
```bash
|
||||
npm run preview
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user