Quickstart

How do I get started?

Installing Bench

  BenchSetup.exe

At first create a folder for Bench on your harddrive or a thumbdrive.

Then download the setup program BenchSetup.exe.

The current web browsers are quite protective if it comes to downloaded executable files. That is why they flag the downloaded program to inform Windows about the potentially unsave origin of the file. To remove the flag, open the properties dialog of the file in the Windows Explorer and approve of the file, to allow execution.

Now simply run BenchSetup.exe and choose the folder you created for Bench in the next dialog. Then follow the steps in the initialization wizzard. After the wizzard is completed, the required apps for Bench are set up, and the Bench Dashboard pops up.

You can find a more detailed description in the tutorial for Setting-Up Bench.

Installing Apps

When Bench is installed and the Bench Dashboard is poped up, it is time to select and install the apps you want to use. Open the Setup Window, if not allready open, and take a look into the App List. There are single apps and app groups listed.

To activate an app or a group, just check the box in the column Active. You can observe, that some boxes are in the third state, meaning, they are neither checked nor not checked. These apps are activated implicitly as a dependency of Bench or another activated app.

To start the download and installation of all activated apps, just click on the Auto Setup Button Auto Setup Button in the top on the right side. After the setup process has finished, you can close the setup window.

You can find a more detailed description of the app management in the tutorials Selecting and Installing Apps and Defining Custom Apps.

Setting-Up a Project

If you want to create a new project with an IDE like Eclipse, open the IDE via its Launcher and initialize the project from within the IDE.

If you want to create a new project manually or with a command line tool, first open a shell from the Bench Dashboard. Your current working path should be the projects directory in the Bench root directory. If that is not the case use cd to switch to it. Then create your project folder via mkdir yourproject, change your location into it via cd yourproject and optionally call a scaffolding tool, e.g. yo for Yeoman.

If you want to clone an existing Git project, first open a shell from the Bench Dashboard. Your current working path should be the projects directory in the Bench root directory. If that is not the case use cd to switch to it. Then just use the git clone command to clone your project into a new project folder.

E.g. git clone https://github.com/yourname/yourproject.git yourproject

Working in a Project

The only important thing, when working on a project in the Bench environment, is to start the IDE or text editor through its Launcher, and to call command line tools from a Bench Shell.

When working with an IDE or a full-featured text editor, start it via its Launcher in the Bench Dashboard or its shortcut in the launchers directory. Then open your project from within the IDE or text editor. This way, the process of the IDE or editor has the Bench apps on the PATH.

When working on the command line, just open a Bench Shell from the Bench Dashboard or via its shortcut in the launchers directory. Change the current directory to your project, which mostly is a sub-directory in the projects directory, and use the command line tools you like. If you miss a command line tool, checkout the app list, maybe it is allready listed and you can just activate it.

You can find a more detailed description of working in a project in the tutorial Working in a Project.