57 lines
1.8 KiB
Markdown
57 lines
1.8 KiB
Markdown
|
|
|
|
|
|
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fmarcus13345%2Fvogue?ref=badge_shield)
|
|
|
|
[](https://nodei.co/npm/vogue-runtime/)
|
|
|
|
Vogue is a programming language that leverages javascript to create no-config graph systems.
|
|
|
|
# Getting Started
|
|
|
|
To create a vogue system, create a vogue module file in a new folder:
|
|
`example/main.v`
|
|
```
|
|
singleton;
|
|
|
|
restore {
|
|
console.log('Hellow Vogue!');
|
|
}
|
|
```
|
|
then run your system with `vogue example`.
|
|
|
|
# NPM Integration
|
|
|
|
your vogue system folder may have a `package.json` and a `node_modules` folder. If they do, you can import javascript modules into your vogue module.
|
|
|
|
```
|
|
example
|
|
|-- package.json
|
|
|-- main.v
|
|
`-- node_modules
|
|
`-- package
|
|
|-- package.json
|
|
`-- index.js
|
|
```
|
|
```
|
|
singleton;
|
|
|
|
import package from 'package';
|
|
|
|
restore {
|
|
console.log(package.foo());
|
|
}
|
|
```
|
|
|
|
# Persistence
|
|
|
|
Vogue systems automagically persist their data, unless otherwise specified. This data is stored inside the `.system` directory.
|
|
|
|
# Documentation
|
|
|
|
For the full spec of vogue module syntax, see: [syntax](docs/syntax.md).
|
|
|
|
To see some common examples and programming patterns, see [examples](examples).
|
|
|
|
# License
|
|
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fmarcus13345%2Fvogue?ref=badge_shield) |