Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Get Started with RAW: Hello world!

It's easy, follow these steps to get going with RAW.

If you get stuck, watch our video (4 mins):

Get Started with RAW: Hello World

Pre-requisites

  • GitHub account (personal one is fine)
  • Download and install VS Code
  • RAW id - to request access, email us at hello@raw-labs.com or go to our website and register. We will set you up with an Organization Name, and send this to your email.

1. GitHub

go to this secton on YouTube

  • Log into your GitHub account, and Fork this hello-world repository (top right) to your account
  • RAW needs access to your new repository in order to synchronize and execute code. Go to our Repository Reader GitHub app, Click Configure and select your GitHub Account, then the repository you just created, to allow RAW to access it. (You can also give RAW access to all, or multiple repositories)
  • To Develop locally, clone your new forked repository, either in GitHub Deskop, command-line, or do it below in VS Code if you prefer

2. RAW App

go to this secton on YouTube

  • You will receive an email to reset your password (from no-reply@raw-labs.com), click on the link inside to set your password
  • Login to the RAW App, enter the "Organization Name" we assigned you, and click "Administration"
  • Enter email and new password to login
  • Once logged into the RAW App, click on your email account from the top right corner menu and copy the token (you will need it later for VS Code).

3. VS Code

go to this secton on YouTube. Also, full instructions for the VS Code extension can be found here

  • In VS Code, search for the RAW Labs extension in the standard Marketplace and install it. You can find it here too.

  • Clone the new repository if you haven't alraeady, in VS Code (you will need a GitHub Extension)

  • Click on the RAW Labs extension on the left side bar, and navigate to 'hello-world.yml' in the RAW File Explorer (top left). Click on the Green 'run' arrow. You will be prompted to authenticate, click Allow, and then paste your Personal Access Token that you copied earlier at the top of the screen and hit Enter. The "Hello World!" message should now appear in an output window.

  • There is also a Scratchpad, you can enter commands here and click green 'run' arrow on the top right of the scratchpad window. This is where you can develop your own code.

  • Click on the 'hello-name.yml' file in the RAW File Explorer. This endpoint requires a parameter. Underneath the File Explorer there is a 'Test YAML Arguments' area. Click on 'Add Arguments Set'. Check 'Argument Set 0' and enter 'name' and 'yourname'. Now click on the 'run' arrow next to 'hello-name.yml'. The output should read accordingly using 'Hello !"

That's it! You're set up :-)

You can now go back to the RAW App, click 'Refresh' in the Catalog, and see the endpoints in the same path as your Git Repository, and the Repositories with main branch showing Active

From the catalog menu, you can copy the URL endpoint for either 'hello-world' or 'hello-name' endpoints to your browser address bar and verify they are working. Endpoints will be named 'yourOrganization' instead of 'api'

hello-world

hello-world()
returns "Hello World!"

https://api.raw-labs.com/hello-world/hello-world

hello-name

hello-name(name: string)
returns "Hello name!"

https://api.raw-labs.com/hello-world/hello-name?name=Joe

About

Introduction to using RAW

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors