Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blenderskool/vyaakaran
📜 Visualize formal languages and automata
https://github.com/blenderskool/vyaakaran
automata compiler context-free-grammar editor ide regular-grammar turing-machine visualizer
Last synced: about 2 months ago
JSON representation
📜 Visualize formal languages and automata
- Host: GitHub
- URL: https://github.com/blenderskool/vyaakaran
- Owner: blenderskool
- License: mit
- Created: 2021-01-16T06:19:46.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-21T20:33:31.000Z (3 months ago)
- Last Synced: 2024-06-23T11:20:36.476Z (3 months ago)
- Topics: automata, compiler, context-free-grammar, editor, ide, regular-grammar, turing-machine, visualizer
- Language: TypeScript
- Homepage: https://vyaakaran.now.sh
- Size: 1.4 MB
- Stars: 35
- Watchers: 1
- Forks: 4
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Vyaakaran - Visualize formal languages and automata
### Features
- Regular languages.
- Context free languages.
- Turing machine simulator.
- Powerful console with nifty utilities.
- Completely client-side on the browser.
### Project structure
The Vyaakaran project has following three modules:
- **Compiler**
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.
- Built with [TypeScript](https://www.typescriptlang.org/).
- The package name is `@vyaakaran/compiler`.
- **Editor**
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.
- Built with [Vue 3](https://vuejs.org/), [TypeScript](https://www.typescriptlang.org/), [WindiCSS](https://windicss.org/).
- The package name is `@vyaakaran/editor`.
- **Website**
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.
- Built with [Svelte Kit](https://kit.svelte.dev/), [TypeScript](https://www.typescriptlang.org/), [WindiCSS](https://windicss.org/).
- The package name is `@vyaakaran/website`.
All the above modules are a part of this monorepo itself under their respective directories. pnpm workspaces is used to manage all the modules.
### Local setup
#### Prerequisites
Following tools must be installed:
- [Node.js 20.x](https://nodejs.org/)
- [pnpm](https://pnpm.io/)
#### Running the dev server
1. At the root of the project, run:
```bash
pnpm install
```
2. To start the dev server of all the modules, run:
```bash
pnpm run dev
```
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:
- `compiler`: `pnpm run compiler:dev`
- `editor`: `pnpm run editor:dev`
- `website`: `pnpm run website:dev`
3. The dev server should start running. To view the changes for:
- `compiler`: Modify `compiler/src/playground.ts` file and run `pnpm run playground` inside `compiler` directory.
- `editor`: Open `localhost:3000`.
- `website`: Open `localhost:3001`.
### Building for production
To build all the modules, run:
```bash
pnpm run build
```
Running the above command will produce following artifacts:
- `compiler/dist/` will contain the built `@vyaakaran/compiler` package.
- `build/playground/` will contain the built Vyaakaran editor.
- `build/` will contain the rest of Vyaakaran website.
If you want to build only some of the modules, run its corresponding command:
- `compiler`: `pnpm run compiler:build`
- `editor`: `pnpm run editor:build`
- `website`: `pnpm run website:build`
## License
Vyaakaran is [MIT Licensed](https://github.com/blenderskool/vyaakaran/blob/master/LICENSE)