Link 2 Ink is a visual intelligence platform that transforms GitHub repositories into interactive architectural blueprints and converts web articles into concise, professional infographics.
- Frontend Framework: React 19 + Vite
- Styling: Tailwind CSS
- Icons: Lucide React
- Data Visualization: D3.js
- AI Integration: Google GenAI SDK (
@google/genai)
- Node.js (v22+ recommended)
- npm or yarn
- A Gemini API Key
If you are on Windows, you can simply double-click the start.bat file. It will:
- Check for Node.js
- Create a
.envfile if it doesn't exist - Install dependencies if needed
- Start the development server
- Copy
.env.exampleto.env:cp .env.example .env
- Open
.envand add your Gemini API Key:GEMINI_API_KEY=your_api_key_here
- Install dependencies:
npm install
- Start the development server:
npm run dev
- Open
http://localhost:3000in your browser.
You can also run the application using Docker Compose:
- Ensure Docker and Docker Compose are installed.
- Run the following command:
docker-compose up --build
- Open
http://localhost:3000in your browser.
- The application should load the home screen with a "Link2Ink Studio" header.
- If you haven't set an API key or if the environment doesn't provide one, an API Key Modal will prompt you to enter one.
- Navigate to "GitFlow" or "SiteSketch" to test the repository analyzer and article-to-infographic features.
- Port 3000 in use: Ensure no other application is using port 3000. You can change the port in
vite.config.tsif necessary, though 3000 is the default. - API Key issues: Ensure your
GEMINI_API_KEYis correctly set in.env. The app usesprocess.env.GEMINI_API_KEYvia Vite'sdefineconfig.