{"id":22547661,"url":"https://github.com/rohittcodes/twix","last_synced_at":"2025-03-28T09:12:02.120Z","repository":{"id":245706996,"uuid":"813372443","full_name":"rohittcodes/twix","owner":"rohittcodes","description":null,"archived":false,"fork":false,"pushed_at":"2024-06-29T04:34:09.000Z","size":388,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-19T22:45:14.893Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rohittcodes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-11T00:49:19.000Z","updated_at":"2025-01-11T11:20:55.000Z","dependencies_parsed_at":"2024-06-29T05:32:55.581Z","dependency_job_id":null,"html_url":"https://github.com/rohittcodes/twix","commit_stats":null,"previous_names":["rohittcodes/twix"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rohittcodes%2Ftwix","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rohittcodes%2Ftwix/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rohittcodes%2Ftwix/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rohittcodes%2Ftwix/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rohittcodes","download_url":"https://codeload.github.com/rohittcodes/twix/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245999594,"owners_count":20707568,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-07T15:12:34.281Z","updated_at":"2025-03-28T09:12:02.099Z","avatar_url":"https://github.com/rohittcodes.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Twix\n\nTwix is a simple, yet effective tool for mind mapping you ideas into a visual representation. It is a web application that allows you to create, edit and customize your mind maps. Twix is a great tool for brainstorming, planning, organizing and presenting your ideas.\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n- [Technologies](#technologies)\n- [Usage](#usage)\n- [Additional Usage](#additional-usage)\n- [Contributing](#contributing)\n- [License](#license)\n\n  \n\n## Features\n\n- Create mind maps with nodes and connections\n- Customize nodes and connections with colors and styles\n- Drag and drop nodes to rearrange them\n- Zoom in and out of the mind map\n- AI integration for auto-generating mind maps\n  - Text to mind map conversion\n  - Explainable AI for mind map generation, and AI suggestions for mind map improvement\n  - AI-powered mind map analysis and insights\n- Export mind maps as json, png, pdf, svg, txt, and markdown files. (JSON is the default format, and others are yet to be implemented)\n- Import mind maps from json files\n\n## Installation\n\n1. Clone the repository\n2. Install the dependencies\n   ```bash\n   npm install\n   ```\n3. Start the development server\n   ```bash\n    npm run dev\n    ```\n4. Open the browser and go to `http://localhost:3000`\n5. Start creating mind maps!\n6. To build the project for production, run\n   ```bash\n   npm run build\n   ```\n    and then\n    ```bash\n    npm run start\n    ```\n7. To run the tests, run\n  ```bash\n   npm run test\n   ```\n\n## Technologies\n\n- [React](https://reactjs.org/)\n- [Next.js](https://nextjs.org/)\n- [CopilotKit](https://docs.copilotkit.ai/)\n- [DagreJS](https://www.npmjs.com/package/dagrejs)\n- [React Flow](https://reactflow.dev/)\n- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction)\n- [Zod](https://zod.dev/)\n- [Shadcn-ui](https://ui.shadcn.com/)\n- [Radix-ui](https://radix-ui.com/)\n\n## Usage\n\n1. Create a new twix file by clicking on the `File` menu and selecting `New File` or `Save as new file`, as there's always a default file open.\n2. Add nodes by clicking on the `Edit` menu and selecting `Add Node`.\n3. Connect nodes by clicking on the `Edit` menu and selecting `Connect Nodes`.\n4. Customize nodes and connections by right-clicking on them.\n5. Drag and drop nodes to rearrange them.\n6. Zoom in and out of the mind map using the zoom buttons.\n7. Export the mind map by clicking on the `File` menu and selecting `Export`.\n8. Import a mind map by clicking on the `File` menu and selecting `Import`.\n\n## Additional Usage\n\n1. To use the AI features, click on the `Chat with AI` button on the bottom right corner.\n2. You can even generate suggestions for your mind map by clicking on the `Generate Suggestions` button, which can be accessed when a node is selected.\n\n## Contributing\n\n1. Fork the repository\n2. Create a new branch\n3. Make your changes\n4. Commit your changes\n5. Push to the branch\n6. Create a pull request\n7. Wait for the pull request to be reviewed\n8. Merge the pull request\n9. Celebrate your contribution!\n10. If you find any bugs or have any feature requests, please create an `issue`.\n\n## Contributors\n\n- [RohittCodes](https://github.com/RohittCodes)\n- [iamaburrasheed](https://github.com/iamabdurrasheed)\n- [7monish0](https://github.com/7monish0)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frohittcodes%2Ftwix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frohittcodes%2Ftwix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frohittcodes%2Ftwix/lists"}