https://github.com/asbjornenge/arch
Simplify your architecture.
https://github.com/asbjornenge/arch
architecture editor software-design
Last synced: 11 months ago
JSON representation
Simplify your architecture.
- Host: GitHub
- URL: https://github.com/asbjornenge/arch
- Owner: asbjornenge
- License: mit
- Created: 2023-08-28T13:10:03.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-04T13:18:15.000Z (over 2 years ago)
- Last Synced: 2025-05-12T16:45:22.770Z (about 1 year ago)
- Topics: architecture, editor, software-design
- Language: JavaScript
- Homepage:
- Size: 2.48 MB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Arch
Simplify your architecture.
Arch is an architectural editor for any project. Draw your diagrams and write documentation in one simple app :tada:
Arch is built using [Electron](https://www.electronjs.org/) and [React](https://react.dev/).
## Diagram
For drawing diagrams we use the fantastic [ReactFlow](https://reactflow.dev/) library. Boxes can have different shapes, colors, be groups etc.
Boxes can also have files attached to them. Files that exist can be opened in a simple *code editor*.
## Notes
Notes are written in Markdown, and we use [React SimpleMDE](https://github.com/RIP21/react-simplemde-editor). It is a nice wrapper around [CodeMirror](https://codemirror.net/).
## Code
For opening and editing files attached to boxes we use the [React Monaco Editor](https://github.com/react-monaco-editor/react-monaco-editor) code editor.
## .arch
Files should be saved with the .arch suffix. The `.arch` files are JSON files with a particular struct that Arch understands.
## Export
Diagram export as `.png`.
Notes export as `.pdf`.
enjoy.