Getting Started with Sausalito Tools for Eclipse

Sausalito tools for Eclipse provides support for your whole software development process, from testing and debugging to the deployment.

In order to get the Sausalito Tools up and running you simply need to follow these steps:

1. Download Sausalito Tools for Eclipse from the Download page
   
   Linux Users only: Additionally download and install the Sausalito Command Line Tools. Please, find instructions here: Get started with the CoreSDK
   
   
2. Unzip the package to a place of your choice
3. Go to the unzipped directory Sausalito Tools and start the sausalito executable
4. If you start the Sausalito Tools for the first time you need to select a Workspace, i.e. a directory of your choice, which will be used to store all Sausalito Projects that you will create.

To create a new project from Sausalito Tools main workbench follow these steps:

1. click on "File", "New", and choose "Sausalito Project".
   
2. The "New Project Wizard" of Sausalito is requiring a project name and a logical URI. The logical URI is an arbitrary identifier for your project that acts as a base URI for all your XQuery module namespaces that you may add to your project. Finally, click "Finished".
   
   If you are new to Sausalito and/or XQuery, you could also use one of the project templates available.
   

   Linux Users only: If the "Use default interpreter" does not show a current interpreter (see screenshot) you need to click "Configure interpreters..." and point the Sausalito Tools to the bin/sausalito script within your installed Sausalito Commandline Tools.
   
3. If you want to learn more about the Sausalito project structure, read section Sausalito Project Structure.

In order to test your project locally, you need to use the Sausalito launcher:

1. Select a File or Directory within the Project Explorer on the left-hand side and click the green "Run" button in the top toolbar (see screenshot).
   
2. The status of the running application will appear in the eclipse console:
   
3. The Sausalito launcher will automatically open the start page of the project within the internal browser of Sausalito Tools...
   
4. ... but you could also use your favorite browser once the project has started. Simply, point your browser to http://localhost:8080.
   
5. Now, you can start working on the XQuery code...
   
6. ... and see your changes by refreshing the browser (no restart of the server is required):
   
7. Sausalito Tools for Eclipse is providing assistance to write your application in XQuery. It features:
   • Semantic highlighting
   • Static code analysis
   • Code completion and templates
   • Code outline
   • Debugger
   
   
8. When you want to stop developing you can click on the red "Stop" button in the top toolbar of the status panel:
   
9. Before restarting a project, you have to wait until the shutdown process has finished stopping the server:
   

In order to make your app accessible throughout the internet, you need to do the following steps:

1. Register an account within the 28msec portal and/or sign in.
2. Click on "Manage Applications" > "Create New Application" and create a new application, for example called "myproject". The application name has to be unique across all users for every Sausalito application. Therefore, the name "test" is most probably already in use by another user.
   
3. Now, within the Sausalito Tools right click on your project and select "Deploy Project...":
   
4. Enter the application name of the app that you created in the portal, your username, and password. Click "Finish".
   
5. After the project has successfully been deployed...
   
6. ... you can immediately access it through the web using the app name that you used to create the project as prefix for ".my28msec.com", for example the project "myproject" is then accessible via http://myproject.my28msec.com.