Skip to content

wavemakercards/wavemaker-v4

Repository files navigation

Contributors
Forks
Stargazers
Issues
MIT License

Logo

Wavemaker Cards

🚀 A comprehensive creative writing and planning suite
Build better stories with powerful visualization tools

🌐 Try Web Version »

� View Demo · 🐛 Report Bug · 💡 Request Feature

✨ Features

🖋️ Distraction-Free Writing

  • Clean, focused writing environment
  • Rich text editor with formatting tools
  • Character and word count tracking
  • Auto-save functionality

🗺️ Mind Mapping

  • Interactive visual story planning
  • Drag-and-drop node creation
  • Connect ideas with visual links
  • Export and import capabilities

⏱️ Timeline Planning

  • Chronological story organization
  • Event sequencing and plotting
  • Visual timeline representation
  • Chapter and scene management

📋 Grid Planner

  • Structured story organization
  • Customizable planning grids
  • Character tracking across scenes
  • Plot point management

❄️ Snowflake Method

  • Implementation of Randy Ingermanson's Snowflake Method
  • Step-by-step story development
  • Character arc planning
  • Progressive story expansion

🗃️ Cards Database

  • Centralized story element management
  • Character profiles and development
  • Location and world-building cards
  • Research and reference organization

📋 Planning Board

  • Kanban-style story planning
  • Move story elements through stages
  • Visual project management
  • Flexible workflow organization

🔄 Progressive Web App (PWA)

  • Works offline
  • Install on desktop and mobile
  • Automatic updates
  • Cross-platform compatibility

📱 Platform Support

  • 🌐 Web: All modern browsers with full functionality
  • 📱 Mobile: iOS, Android (Progressive Web App)
  • 💻 Desktop: Install as PWA on Windows, macOS, Linux
  • ☁️ Cloud Sync: Google Drive integration for cross-device access

🛠️ Built With

  • Frontend: Vue.js 3, HTML5, CSS3
  • Editor: TipTap (rich text editing)
  • Database: Dexie.js (IndexedDB)
  • Build Tool: Vite
  • PWA: Workbox
  • UI Components: Custom Vue components
  • Charts: Vue Chart.js

🚀 Getting Started

Prerequisites

Node.js >= 21.6.1
npm >= 10.2.4

Installation

  1. Clone the repository

    git clone https://github.com/wavemakercards/wavemaker-cards-v4.git
    cd wavemaker-cards-v4
  2. Install dependencies

    npm install
  3. Start development server

    npm run dev
  4. Build for production

    npm run build
  5. Preview production build

    npm run preview

🎯 Usage

Quick Start

  1. Create a new project or open an existing one
  2. Choose your tool:
    • Start with Mind Mapping for initial brainstorming
    • Use Snowflake Method for structured development
    • Switch to Writer for distraction-free writing
    • Organize with Grid Planner or Planning Board
  3. Sync your work with Google Drive for backup and cross-device access

Tool Workflow

💡 Ideas → 🗺️ Mind Map → ❄️ Snowflake → 📋 Grid/Board → 🖋️ Writing

📊 Project Structure

src/
├── components/           # Vue components
│   ├── writer/          # Writing interface
│   ├── mindmap/         # Mind mapping tools
│   ├── timeline/        # Timeline planning
│   ├── gridplanner/     # Grid planning system
│   ├── snowflake/       # Snowflake method
│   ├── planningboard/   # Kanban-style planning
│   ├── cardsdatabase/   # Content management
│   └── universal/       # Shared components
├── mixins/              # Vue mixins
├── composables/         # Vue 3 composables
├── css/                 # Styling
└── languages/           # Internationalization

🤝 Contributing

Contributions make the open source community amazing! Any contributions are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📄 License

Distributed under the MIT License. See LICENSE for more information.

📞 Contact

Wavemaker Cards Team

Project Link: https://github.com/wavemakercards/wavemaker-cards-v4

🙏 Acknowledgements

  • aMadReason - For being an incredibly knowlegable rubber duck!
  • Vue.js Team - For the amazing framework
  • TipTap - For the excellent rich text editor
  • Randy Ingermanson - For the Snowflake Method
  • All Contributors - Who help make this project better

Made with ❤️ for writers, by writers
Version 4.1.5

About

The Version 4 release of wavemaker - Nov 2022

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5