Skip to content

mayu-live/starter

Repository files navigation

mayu-live/starter

This is a simple starter kit for mayu live.

You can find more documentation at mayu.live/docs.

Beware that this is experimental software.

If you have all dependencies installed, you should be able to deploy the app within a few minutes.

Get started

Install dependencies

Make sure you have the latest versions of Ruby and NodeJS. If you have asdf you can install them by typing:

asdf install

Setup the starter kit

Clone and setup

git clone https://github.com/mayu-live/starter.git my-app
cd my-app
bundle install
rake setup

Ready to run

To start the development server, run:

bin/mayu dev

If everything worked, you should be able to visit https://localhost:9292/

Deploying on fly.io

Make sure you have installed flyctl and that you have an account at fly.io and that you have logged in.

Then, generate a fly.toml config file by running the following command:

rake launch_on_fly

This will set up everything for you and ask you if you want to deploy after.

Otherwise, you can deploy at any time by typing:

fly deploy

Contributing

Beware that there are bugs and rough edges.

Contributions are welcome! Please create issues on github or send pull requests if you fix something!