Nylo home page
  1. Getting Started
  2. Installation
Getting Started

Installation


Install

You can either download Nylo here or clone the git repository using the below command.

git clone https://github.com/nylo-core/nylo.git nylo_app

Note: run flutter pub get when opening the project for the first time to fetch all dependencies.


Running the project

Nylo projects run in the exact 'normal' way you'd build a Flutter app. Depending on which IDE you have chosen, this part will be slightly different.

Check this guide here for Android Studio or Visual Studio Code.

Once you have done the above steps, try running the project. If the build is successful, the app will display Nylo's default landing screen.


Metro CLI tool

Nylo provides a CLI tool called Metro. It's been built, so you can run commands in the terminal to create things. With Metro, you can create the following in your project:

  • Models
  • Controllers
  • Pages
  • Stateful widgets and stateless widgets
  • State managed widgets
  • Events
  • Providers
  • API Services
  • Themes
  • Route Guards
  • Forms
  • Configs
  • Interceptors

E.g. Running dart run nylo_framework:main make:model Post will create a new 'Post' model in your project.

To access the menu, you can run the below in the terminal.

dart run nylo_framework:main


Installing Metro alias MacOS

Typing dart run nylo_framework:main each time you want to run a command is long so, to make things easier, create an alias.

If you're new to aliases, they allow you to create alternative names for your commands.

E.g. dart run nylo_framework:main can become metro.

Adding the alias

In the terminal run the following:

sudo echo "alias metro='dart run nylo_framework:main'" >>~/.bash_profile && source ~/.bash_profile

This will add the metro alias to your bash_profile and reload it. Try running the below.

metro

If you see the Metro CLI menu, you have successfully added the alias.

Can't find your bash_profile?

If you are unsure where to add the above, check out some guides online for where to find your bash_profile file. The above example assumes that your bash_profile is in your ~/ location.


Installing Metro alias Windows

  1. Open PowerShell as an administrator.
  2. Create a PowerShell profile if you don't have one:
if (!(Test-Path -Path $PROFILE)) {
    New-Item -ItemType File -Path $PROFILE -Force
}
  1. Open the profile in a text editor:
notepad $PROFILE
  1. Add the following line to the profile:
function metro { dart run nylo_framework:main @args }
  1. Save the file and close the editor.
  2. Reload your PowerShell profile:
. $PROFILE

Now you can use metro instead of dart run nylo_framework:main in your terminal or command prompt.

Try using metro in your terminal. You should see the below output.

All commands:
 
[Widget Commands]
  make:page
  make:stateful_widget
  make:stateless_widget
  make:state_managed_widget
  make:navigation_hub
  make:form

[App Commands]
  make:model
  make:provider
  make:api_service
  make:controller
  make:event
  make:theme
  make:route_guard
  make:config
  make:interceptor

Now you can type metro from your terminal to run commands in your Nylo project.

E.g. metro make:controller profile_controller