https://github.com/katebrune/blueatom
blueatom is an application to create diagrams. It extends PlantUML syntax to allow for a more feature rich diagram creation experience.
https://github.com/katebrune/blueatom
diagramming plantuml
Last synced: 8 months ago
JSON representation
blueatom is an application to create diagrams. It extends PlantUML syntax to allow for a more feature rich diagram creation experience.
- Host: GitHub
- URL: https://github.com/katebrune/blueatom
- Owner: katebrune
- License: gpl-3.0
- Created: 2024-04-14T17:40:05.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-08-15T22:16:06.000Z (about 1 year ago)
- Last Synced: 2024-08-15T23:32:41.215Z (about 1 year ago)
- Topics: diagramming, plantuml
- Language: TypeScript
- Homepage: https://blueatom.dev
- Size: 106 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# blueatom
blueatom is an application to create software diagrams. It extends PlantUML syntax to allow for a more feature rich diagram creation experience.
Check it out at [blueatom.dev](https://blueatom.dev)
## Features
- Full PlantUML diagramming experience
- Ability to enable additional PlantUML libraries
- Add layers to diagrams to create multiple views from a single document
## Usage/Examples
### Sequence diagram with layers
```plantuml
@[my-first-layer]
Me->blueatom: Hello!
@[my-second-layer]
blueatom->Me: Hi!
```
### C4 diagram with layers
Enable C4 library in the Settings tab first.
```plantuml
Person(user, "User")
SystemBoundary(mysystem, "My System") {
Container(ui, "ui")
Container(api, "api")
ContainerDb(db, "db")
@[with-new-service]
Container(mynewservice, "My New Service")
}
Rel(user, ui, "")
Rel(ui, api, "")
Rel(api, db, "")
@[with-new-service]
Rel(api, mynewservice, "")
```
## Support
For support, create a new Issue.
## License
[GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/)
## Running locally
1. Start plantuml server
```bash
docker compose up -d
```
2. Configure env vars
```bash
echo "VITE_BLUEATOM_API_URL=http://localhost:8080" > .env
```
3. Install dependencies
```bash
nvm use
yarn install
```
4. Start dev server
```bash
yarn dev
```