{"id":13599657,"url":"https://github.com/blenderskool/vyaakaran","last_synced_at":"2025-03-15T14:30:44.277Z","repository":{"id":204080744,"uuid":"330098595","full_name":"blenderskool/vyaakaran","owner":"blenderskool","description":"📜 Visualize formal languages and automata","archived":false,"fork":false,"pushed_at":"2024-08-28T19:31:25.000Z","size":1153,"stargazers_count":54,"open_issues_count":12,"forks_count":9,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-27T03:06:27.952Z","etag":null,"topics":["automata","compiler","context-free-grammar","editor","ide","regular-grammar","turing-machine","visualizer"],"latest_commit_sha":null,"homepage":"https://vyaakaran.now.sh","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/blenderskool.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2021-01-16T06:19:46.000Z","updated_at":"2025-02-20T17:15:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"1ef5108d-1a33-4c43-87e6-271cf745ffab","html_url":"https://github.com/blenderskool/vyaakaran","commit_stats":null,"previous_names":["blenderskool/vyaakaran"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blenderskool%2Fvyaakaran","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blenderskool%2Fvyaakaran/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blenderskool%2Fvyaakaran/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blenderskool%2Fvyaakaran/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blenderskool","download_url":"https://codeload.github.com/blenderskool/vyaakaran/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243742621,"owners_count":20340673,"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":["automata","compiler","context-free-grammar","editor","ide","regular-grammar","turing-machine","visualizer"],"created_at":"2024-08-01T17:01:08.534Z","updated_at":"2025-03-15T14:30:43.458Z","avatar_url":"https://github.com/blenderskool.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cp align=\"center\"\u003e\n    \u003ca href=\"https://vyaakaran.now.sh\"\u003e\n      \u003cimg src=\"https://github.com/blenderskool/vyaakaran/raw/main/website/static/vyaakaran-icon.png\" width=\"80\"\u003e\n    \u003c/a\u003e\n  \u003c/p\u003e\n  \u003cp align=\"center\"\u003e  \n    \u003ch3\u003eVyaakaran - Visualize formal languages and automata\u003c/h3\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n### Features\n- Regular languages.\n- Context free languages.\n- Turing machine simulator.\n- Powerful console with nifty utilities.\n- Completely client-side on the browser.\n\n### Project structure\n\nThe Vyaakaran project has following three modules:\n- **Compiler**  \n  This is the underlying module that powers all the magic behind Vyaakaran! It contains the code for the lexer, parser, analyzer and all the other algorithms for processing regular, context-free grammars, and Turing machines.\n  - Built with [TypeScript](https://www.typescriptlang.org/).\n  - The package name is `@vyaakaran/compiler`.\n\n- **Editor**  \n  This is the visual web-based editor which can be accessed at [vyaakaran.now.sh/playground](https://vyaakaran.now.sh/playground). It uses the Compiler module and builds a nice UI over it which helps in writing, visualizing, and testing the grammars and Turing machines in an interactive way.\n  - Built with [Vue 3](https://vuejs.org/), [TypeScript](https://www.typescriptlang.org/), [WindiCSS](https://windicss.org/).\n  - The package name is `@vyaakaran/editor`.\n\n- **Website**  \n  This is the [vyaakaran.now.sh](https://vyaakaran.now.sh) website. It currently highlights Vyaakaran's features, and will be the place for any blog posts and documentation for Vyaakaran.\n  - Built with [Svelte Kit](https://kit.svelte.dev/), [TypeScript](https://www.typescriptlang.org/), [WindiCSS](https://windicss.org/).\n  - The package name is `@vyaakaran/website`.\n\nAll the above modules are a part of this monorepo itself under their respective directories. pnpm workspaces is used to manage all the modules.\n\n\n### Local setup\n\n#### Prerequisites\nFollowing tools must be installed:\n- [Node.js 20.x](https://nodejs.org/)\n- [pnpm](https://pnpm.io/)\n\n#### Running the dev server\n1. At the root of the project, run:\n   ```bash\n   pnpm install\n   ```\n2. To start the dev server of all the modules, run:\n   ```bash\n   pnpm run dev\n   ```\n   Depending on the module you want to work on, you can only start the dev server of that particular module by running its corresponding command:\n   - `compiler`: `pnpm run compiler:dev`\n   - `editor`: `pnpm run editor:dev`\n   - `website`: `pnpm run website:dev`\n\n3. The dev server should start running. To view the changes for:\n   - `compiler`: Modify `compiler/src/playground.ts` file and run `pnpm run playground` inside `compiler` directory.\n   - `editor`: Open `localhost:3000`.\n   - `website`: Open `localhost:3001`.\n\n### Building for production\nTo build all the modules, run:\n```bash\npnpm run build\n```\n\nRunning the above command will produce following artifacts:\n- `compiler/dist/` will contain the built `@vyaakaran/compiler` package.\n- `build/playground/` will contain the built Vyaakaran editor.\n- `build/` will contain the rest of Vyaakaran website.\n\nIf you want to build only some of the modules, run its corresponding command:\n- `compiler`: `pnpm run compiler:build`\n- `editor`: `pnpm run editor:build`\n- `website`: `pnpm run website:build`\n\n## License\nVyaakaran is [MIT Licensed](https://github.com/blenderskool/vyaakaran/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblenderskool%2Fvyaakaran","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblenderskool%2Fvyaakaran","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblenderskool%2Fvyaakaran/lists"}