Skip to content

Julia-powered dashboards, inspired by Material Design

License

Notifications You must be signed in to change notification settings

cyberbryce/Matte.jl

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

64 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Matte.jl

Lifecycle CI codecov.io

Matte is a julia library for julia-powered dashboards, inspired by Google's material design. Matte makes it easy to convert your existing julia code into a beautiful and powerful dashboard for end users. Matte is easy to use, fast, and powerful.

Please note: Matte is still highly experimental.

Examples

Getting started

Installation

Matte is not yet registered in the julia general repository. To install the latest release run the following from the Pkg repl (type ] to get there):

pkg> add https://github.com/angusmoore/Matte.jl.git#v0.1.0

You can install the latest development version by removing the #v0.1.0.

Creating your first app

To create the skeleton for a Matte app, start julia, run using Matte and then run:

julia> new_matte_app("path/to/app")

Matte will create a new folder and julia project at your chosen path and create all the files necessary to get started with Matte. Change your directory to where you just created your app and activate the new project:

julia> cd("path/to/app")
pkg> activate .

(Remember ] gets you into the Pkg repl)

Matte has created a simple app in that directory. The app is defined in the file called app.jl. It defines a module called MyApp. This is, well, your brand new Matte app.

Running your new app

Let's run our new app.

But before we do: a note about Revise. I highly recommend using Revise with Matte. This lets you edit your app and see the changes immediately, without having to restart your app. Revise is included by default when you create a new Matte app, so all we need to do is:

julia> using Revise

Back to our app.

To run the app, we need to first load Matte, and then load our module MyApp:

julia> using Matte
julia> includet("app.jl")

(Note that I use includet from Revise, to track changes to the file. If you aren't using Revise, just use include. But you should definitely use Revise!)

All we need to do now is run our app. We do this using the Matte function run_app, which takes the module that defines our app as argument:

julia> run_app(MyApp)

Matte will take a little while to start. Your app is up and running once you see:

Web Server starting at http://0.0.0.0:8000

Navigate your favourite web browser to the address listed above and (after a few seconds) viola! Your app is ready!

Documentation

Introduction to Matte is a good place to start. It walks you through getting set up, and creating, running and customising your first app.

The official documentation can be found here.

Support, bugs, & planned features

General support for help with usage and troubleshooting is best directed to the julialang discourse.

Please report any bugs you find on the github issue tracker. Feature requests can be logged there too.

Acknowledgements

Matte is made possible by a range of excellent julia and javascript open source libraries. Of particular note: Genie.jl, Vuetify and Vue.js.

About

Julia-powered dashboards, inspired by Material Design

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Julia 85.8%
  • HTML 8.9%
  • JavaScript 5.3%