Sifu is no longer available for public use.
It is now exclusively used for developing Alchemy, an enterprise-grade SaaS platform for the specialty chemicals industry.

Start building with Sifu

Run a simple web application connected to a server in just three simple steps?

1
Setup environment

Required software:

  • Installed Oracle Java SDK (min 1.8.0), if you do not have it you can download it form the official site
  • JAVA_HOME added as the environment variable and part of the Path variable, if you have not done this before take a look at this instruction
    • check it with $ java -version from the command prompt, the output should look something like this, depending on the version you have installed:
      java version "1.8.0_101"
      Java(TM) SE Runtime Environment (build 1.8.0_101-b13)
      Java HotSpot(TM) 64-Bit Server VM (build 25.101-b13, mixed mode)

Setup steps:

  1. Download the latest Sifu version
  2. Run sifu.msi and follow the steps in installer wizard to finish setup
  3. Open CMD, PowerShell or Git Shell
  4. Run $ sifu --help - this should run the application and show the help information for the Sifu command line tool
    Note: If Sifu is not found, make sure to restart your CMD or PowerShell or failing that, log out and log in again

Required software:

  • Installed Homebrew, for instruction how to do it visit their official site

Setup steps:

  1. First time setup
    • Using terminal run brew install drytools/repo/sifu
  2. Update to the latest version
    • Update brew with brew update
    • Upgrade brew packages with brew upgrade
  3. Run $ sifu --help - this should run the application and show the help information for the Sifu command line tool

Required software:

  • Installed Oracle Java SDK (min 1.8.0). If you do not have it on your system please follow this instruction to install it
  • Set JAVA_HOME as environment variable
    • check it with $ java -version from terminal, output should look something like this, depending on version you have installed:
      java version "1.8.0_101"
      Java(TM) SE Runtime Environment (build 1.8.0_101-b13)
      Java HotSpot(TM) 64-Bit Server VM (build 25.101-b13, mixed mode)

Setup steps:

  1. Download latest Sifu version
  2. Using terminal navigate to the directory that contains downloaded package and extract it using this command tar -xzvf sifu-0.x.x.tar.gz. It will create new directory sifu-0.x.x with 2 files in it: sifu script and command-line.jar.
  3. To see the current file path run command $ pwd - result example: /home/user/Downloads/sifu-0.x.x
  4. Our scripts that is on the resulted path from previous step needs to be exported to the PATH of the OS, you can do this by running $ export PATH=$PATH:/home/user/Downloads/sifu-0.x.x - in this way script will be bound to the PATH only for the current terminal process, or you can bind the script and make it work whenever you open the terminal. In order to do this, path should be exported to the bash script (.bashrc - Ubuntu)
    1. run $ cd ~ && sudo nano .bashrc (instead of nano you can open it with whatever editor you want)
    2. add the export PATH="$PATH":/home/user/Downloads/sifu-0.x.x at the end of the file
    3. save file, close and reopen terminal
  5. Run $ sifu --help - this should run the application and show the help information for the Sifu command line tool
2
Initialize project

Create a folder for your project, navigate to it and then run:

sifu init simpleProject

This will create simpleProject.sifu specification document with predefined basic elements that are needed to run AngularJS web application connected to Java Spring Boot server.

If you are using Sifu Community edition you will be asked to accept our Terms of Use, which you must accept in order to continue using Sifu.

Note: We've created a language-sifu plugin for the Atom editor to make writing specifications even easier.

3
Generate application

Make sure you are in the root of your project folder and run:

sifu generate

This will then generate project structure and code for AngularJS application connected to a Java Spring Boot server and Docker Compose files with a ready-made configuration for running the services

What next?

Tutorials

We'll cover all the basics and help you get started from the ground up with easy-going tutorials.

Tutorials

Documentation

Our documentation covers all you need on how to get your application up and running in minutes.

Documentation