Creating your project config

Your project config, also called your ray.config.json file is a file that lives in the root of your project's git repository that tells ray how to deploy your project. The most important part of your project config is called your project's pipeline, which is a series of instructions or commands that specifies steps to build and deploy your project. See the example config below:

ray.config.json

{
  "Version" : "v1",
  "Pipeline" : [
    {
      "Tool" : "npm",
      "Command" : ["install"],
      "Type" : "build"
    }, 
    {
      "Tool" : "node",
      "Command" : ["index.js"],
      "Type" : "deploy"
    }
  ]
}

Here, ray will look for an executable file called "npm" in your system's PATH, then execute it with the argument "install". The type tells ray if the command is just part of the build process or if it is the command that actually starts your application. In this case, the first pipeline step will be identical to running npm install , but note that this often wont be the case, since nothing is ever being passed to the shell (for example, piping and command chaining wont work).

There are also some built-in tools. For example, the "rayserve" tool will automatically statically serve a directory of your application!

Create a file named ray.config.json in your project's git repository and use the example above as a base for constructing your project config.