Skip to content

S4GU4R0/itr8

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ITR8 🎯

A Progressive Web App for tracking connections between problems, solutions, and their iterations.

Next.js TypeScript Tailwind
License Version Build Status
PWA Offline IndexedDB Visual Graph URL Sharing

📖 Table of Contents


✨ Features

📝

Text-based Input

Use Mermaid-like syntax to quickly add items and connections

📊

Visual Graph

See your connections as a beautiful horizontal tree diagram

📶

Offline Support

Works without internet using IndexedDB

📱

PWA Install

Install as a native app on your device

🔗

URL Sharing

Share your data via URL parameters


📦 Prerequisites

📦

Required Software

  1. Node.js 18.0+
    Download from [nodejs.org](https://nodejs.org/)
  2. Bun 1.0+
    Install with: curl -fsSL https://bun.sh/install | bash
  3. Git 2.0+
    Download from [git-scm.com](https://git-scm.com/)

🚀 Quick Start

Terminal — bash
📁 itr8
📦 bun install
🚀 bun run dev
💡 Open http://localhost:3000 in your browser

📝 Text Input Syntax

🎯 Create Items

# Create items with prefixes

P: Problem title        # Creates a problem node
S: Solution title       # Creates a solution node
I: Iteration title      # Creates an iteration node

🔗 Create Connections

# Connect items with arrows

Title --solves--> Target      # Solution solves a problem
Title --iterates--> Target    # Iteration of a solution
Title --breaks-down--> Target # Problem breaks into sub-problem
Title --causes--> Target      # Problem causes another problem
Title --> Target              # Related items (default)
🔮

Visual Connection Graph

See your problem-solution iterations as a beautiful tree diagram


📤 Deploy to GitHub Pages

🎯 Option 1: GitHub Actions Deployment (Recommended)

Best for: Projects that need automatic builds and deployments on every push

GitHub Actions Deployment

GitHub Actions Deployment

Automated deployment with GitHub Actions

  1. Push to GitHub

    git init && git add . && git commit -m "Initial commit" && git branch -M main && git remote add origin https://github.com/YOUR_USERNAME/YOUR_REPO.git && git push -u origin main
  2. Enable GitHub Pages

    • Go to your repo on GitHub
    • Settings → Pages → Source → Select "GitHub Actions"
    • The workflow will automatically deploy
  3. Access your app

    • Your app will be at: https://YOUR_USERNAME.github.io/YOUR_REPO/

Root Domain Deployment

username.github.io

  1. Create a repo named YOUR_USERNAME.github.io
  2. Follow Option 1 steps above
  3. Your app will be at: https://YOUR_USERNAME.github.io/

📦 Option 2: Manual Export

Build Static Files

bun run export

The out folder contains your static site. Upload the contents to any static hosting.


⚙️ Configuration

🌐 Custom Domain

🔧 Add CNAME File

  1. Create a CNAME file in public/ folder
  2. Enter your domain (e.g., example.com)

🔧 Configure DNS Configure DNS with your domain provider.

📂 Subdirectory Deployment

📂 Edit next.config.ts

const nextConfig: NextConfig = {
  basePath: "/your-repo-name", // Uncomment and set your repo name
};

💡 Usage Examples

💡

Common Use Cases

See how to use ITR8 for different scenarios

💡 Product Development

Track problems, solutions, and iterations throughout the product development lifecycle.

P: Memory leaks in production --solves--> Implement garbage collection
<div style="background: white; padding: 16px; border-radius: 8px; border-left: 4px solid #10b981;">
  <h4 style="margin: 0 0 8px 0; color: #1f2937;">🛠️ Bug Fixing</h4>
  <p style="margin: 0 0 12px 0; color: #6b7280; font-size: 0.9rem;">Document the process of fixing bugs and the iterations made to improve the solution.</p>
  <div style="background: #1e1e1e; border-radius: 6px; padding: 12px; font-family: 'Courier New', monospace; font-size: 0.85rem;">
    <div style="display: flex; align-items: center; gap: 12px;">
      <span style="color: #61dafb;">P:</span> <span style="color: #f8f8f2;">Login fails on Safari</span>
      <span style="color: #61dafb;">--solves--></span> <span style="color: #f8f8f2;">Fix cookie handling</span>
    </div>
  </div>
</div>

<div style="background: white; padding: 16px; border-radius: 8px; border-left: 4px solid #3b82f6;">
  <h4 style="margin: 0 0 8px 0; color: #1f2937;">📚 Learning Resources</h4>
  <p style="margin: 0 0 12px 0; color: #6b7280; font-size: 0.9rem;">Keep track of learning paths, tutorials, and the problems you're solving.</p>
  <div style="background: #1e1e1e; border-radius: 6px; padding: 12px; font-family: 'Courier New', monospace; font-size: 0.85rem;">
    <div style="display: flex; align-items: center; gap: 12px;">
      <span style="color: #61dafb;">P:</span> <span style="color: #f8f8f2;">Learn React hooks</span>
      <span style="color: #61dafb;">--solves--></span> <span style="color: #f8f8f2;">Watch advanced tutorials</span>
    </div>
  </div>
</div>

<div style="background: white; padding: 16px; border-radius: 8px; border-left: 4px solid #ec4899;">
  <h4 style="margin: 0 0 8px 0; color: #1f2937;">🎯 Research & Innovation</h4>
  <p style="margin: 0 0 12px 0; color: #6b7280; font-size: 0.9rem;">Track research questions, experiments, and their iterations.</p>
  <div style="background: #1e1e1e; border-radius: 6px; padding: 12px; font-family: 'Courier New', monospace; font-size: 0.85rem;">
    <div style="display: flex; align-items: center; gap: 12px;">
      <span style="color: #61dafb;">P:</span> <span style="color: #f8f8f2;">Improve image compression</span>
      <span style="color: #61dafb;">--iterates--></span> <span style="color: #f8f8f2;">Try new algorithms</span>
    </div>
  </div>
</div>

❓ FAQ

🎯 What is ITR8?

ITR8 is a Progressive Web App (PWA) that helps you track connections between problems, solutions, and their iterations using a simple text-based input system. It provides a visual graph to see how problems relate to solutions and how iterations improve your work.

📱 Can I use ITR8 offline?

Yes! ITR8 is designed as an offline-first PWA. All your data is stored locally in your browser using IndexedDB, so you can access it even without an internet connection. Your data will persist between sessions.

🔗 How does URL sharing work?

ITR8 generates shareable URLs containing your data encoded in the URL parameters. You can share these links with others, and they'll be able to view and edit your data. The data is stored locally on their device, so no backend is required.

💾 Is my data secure?

Your data is stored locally in your browser's IndexedDB database. It's not sent to any server, so your information remains private and secure. You have full control over your data and can export it at any time.

🔧 Can I install ITR8 on my device?

Yes! ITR8 supports PWA installation. You can install it as a native app on your device through your browser's menu. This gives you a standalone app experience with its own icon and no browser chrome.

🔄 Can I import data from other sources?

Currently, ITR8 supports importing data via URL sharing. You can open any ITR8 URL that contains your data in the format ?data=... to import that data into your local browser storage.


💾 Data Storage

🔐

Local-First Storage

All data stored in your browser using IndexedDB

📤

Export

Generate shareable URLs via "Export" button

📥

Import

Open URLs with ?data=... to import data


💻 Development

🔍

Lint Code

bun run lint
🏗️

Build for Production

bun run build

🛠️ Tech Stack

⚛️

Framework

Next.js 16
Next.js
🎨

UI Components

Tailwind + shadcn/ui
Tailwind shadcn/ui
🗄️

Database

IndexedDB + Dexie.js
Dexie.js IndexedDB

State Management

Zustand
Zustand
🟦

TypeScript

5.3+
TypeScript

🐛 Issues

🐛

Found a bug or have a feature request?

Please open an issue on GitHub to help us improve the project.

🐛 Open an Issue
💡
Tips for better bug reports:
  • Include steps to reproduce the issue
  • Attach screenshots if applicable
  • Check if the issue already exists before submitting

📝 Changelog

📝

Recent Updates

Check out what's new and what's coming next!

v1.0.0 2024-03-25
  • 🎉 Initial release of ITR8
  • ✨ Add text-based input for problems and solutions
  • 🔗 Visual connection graph for data visualization
  • 📱 PWA support for offline-first experience
  • 📤 URL sharing functionality
  • 🎨 Beautiful UI with gradient backgrounds

Want to see upcoming features? Check the issue tracker


🤝 Contributing

🤝

We ❤️ Contributions!

Contributions are welcome! Whether you want to fix a bug, add a feature, or improve the documentation.

📋

1. Fork the Project

Create your own fork on GitHub

🔨

2. Create Your Branch

git checkout -b feature/AmazingFeature

📝

3. Commit Your Changes

Make your changes with clear commit messages

📤

4. Push to the Branch

git push origin feature/AmazingFeature

🔀

5. Open a Pull Request

Submit your changes for review

💡 Development Guidelines

  • Follow the existing code style and conventions
  • Write clear, descriptive commit messages
  • Test your changes thoroughly before submitting
  • Keep your pull requests focused and small

📄 License

📜

MIT License

This project is licensed under the MIT License - see the LICENSE file for details.

MIT License

Copyright (c) 2024 ITR8

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

📄 View LICENSE File

🌟

Start Building Today

Track your problems, solutions, and iterations with ITR8

🛠️ Built with Next.js Tailwind TypeScript
GitHub Issues Releases License: MIT © 2024 ITR8

About

A simple web app for seeing the connections between problems, solutions, and their iterations.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors