Getting Started with CodeReady Studio Tools

Procedure

1. Start Eclipse IDE.

2. Click Window → Perspective → Open Perspective → Other.

   The Open Perspective window appears.

3. Select Git.

4. Click the Open button.

   The Git Repositories view appears.

Procedure

1. Start CodeReady Studio.
2. Start Git Perspective.

3. Right-click on the target repository → Commit.

   The Git Staging view appears.

4. Select the changes you want to stage.

5. Click the Add selected files to the index button to stage the changes you want to commit.

   Figure 1.4. Stage files to commit

   

6. Add a commit message to the Commit Message field.

   Author and Committer fields are populated automatically.

7. Click the Commit button to commit your changes, or the Commit and Push button to commit your changes and push them to the remote repository.

   Note that when selecting the Commit and Push option you are prompted to enter the repository address, and your access username and password for that repository.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.

3. Click File → New → Other.

   The New window appears.

4. Enter Maven Projects in the Wizards field.
5. Select Maven Projects.

6. Click the Next button.

   The New Maven Project window appears.

7. Check the Create a simple project box.

   Note

   By checking the Create a simple project box you are skipping the archetype selection and the project type is automatically set to Project Object Model (POM). To create a standalone project, clear the Create a simple project check box and follow the onscreen instructions.

8. Click the Browse button to select the workspace location.
9. Click the Next button.

10. Enter the group ID and the artificial ID.

    Note

    The values cannot include spaces or special characters. The only special characters allowed are periods (.), underscores (_), and dashes (-). An example of a typical group ID or artificial ID is org.company-name_project-name.

    Optionally, you can name your project and give it a description.

11. Set Packaging to pom.
12. Click the Finish button.

Verification steps

1. Click Window → Show View → Other.

   The Show view window appears.

2. Enter Project Explorer in the search field.
3. Select Project Explorer.

4. Click the Open button.

   The Project Explorer view appears.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.

3. Click File → New → Other.

   The New window appears.

4. Enter Maven Module in the Wizards field.
5. Select Maven Module.

6. Click the Next button.

   The New Maven Module window appears.

7. Check the Create a simple project box.

   Note

   By checking the Create a simple project box you are skipping the archetype selection and the project type is automatically set to Project Object Model (POM). To create a standalone module, clear the Create a simple project check box and follow the onscreen instructions.

8. Name your module.
9. Click the Browse button to select the parent project.
10. Click the Next button.

11. Set Packaging to pom.

    Optionally, you can name your module and give it a description.

12. Click the Finish button.

Verification steps

1. Click Window → Show View → Other.

   The Show view window appears.

2. Enter Project Explorer in the search field.
3. Select Project Explorer.

4. Click the Open button.

   The Project Explorer view appears.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.
3. Open Project Explorer.
4. Right-click the target project → Maven → Add Dependency.

5. Enter the group ID or the artificial ID in the Enter groupId, artificialId or sha1 prefix or pattern field.

   The fields above are populated automatically.

6. Click the OK button.

1. Start CodeReady Studio.
2. Open Git Perspective.
3. Open Project Explorer.

4. Right-click the target project → Configure → Convert to Maven Project.

   The Create a new POM window appears.

   All fields are populated automatically. If you want to change the group ID or the Artificial ID, note that the values cannot include spaces or special characters. The only special characters allowed are periods (.), underscores (_), and dashes (-).

5. Click the Finish button.

   Your newly generated pom.xml file appears in the System Explorer view.

Procedure

1. Start CodeReady Studio.

2. Click Window → Preferences.

   The Preferences window appears.

3. Enter JBoss Tools in the search field.

4. Select JBoss Maven Integration.

   The JBoss Maven Integration window appears.

5. Click the Configure Maven Repositories button.

   The Maven Repositories window appears.

6. Click the Add Repository button.

   The Add Maven Repository window appears.

7. Click the down-arrow in the Profile ID field.

8. Select the redhat-ga-repository.

   Other fields are populated automatically.

9. Click the OK button.

10. Click the Finish button.

    The Confirm File Update window appears.

11. Click the Yes.
12. Click the Apply and Close button.

Procedure

1. Start CodeReady Studio.
2. Start Git Perspective.

3. Click Window → Preferences.

   The Preferences window appears.

4. Enter JBoss Tools in the search field.

5. Select JBoss Runtime Detection.

   The JBoss Runtime Detection window appears.

6. Click the Download button.

   The Download Runtimes window appears.

7. Select one of the JBoss EAP versions.

   Note

   If you select the JBoss EAP version 6.0.x or earlier, follow the on-screen instructions. If you select a later version, follow the instructions below.

8. Click the Next button.
9. Click the Add button.
10. Enter your access.redhat.com username and password.

11. Click the OK button.

    The Secure Storage Password window appears.

12. Enter the new master password.

    Optionally, you can provide a password hint.

13. Click the Next button.

    Review the license agreement, if satisfied, accept the license and click the Next button to continue with the installation.

14. Click the Browse button to select the Install folder.
15. Click the Browse button to select the Download folder.

16. Click the Finish button.

    The Download Red Hat JBoss EAP) window appears.

    Note that downloading and installing the Runtime might take a while.

17. Ensure the path to the JBoss EAP installation file is checked.
18. Click the Apply and Close button.

Verification steps

1. Click the Window → Show View → Other.

   The Show View window appears.

2. Type Servers in the search field.
3. Select Servers.

4. Click the Open button.

   The Servers view appears.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.
3. Open Project Explorer.

4. Click the Red Hat Central icon.

   Figure 3.1. Click the Red Hat Central icon

   
5. Enter helloworld into the search field.

6. Click the helloworld-rs quickstart.

   The New Project Example window appears.

7. Click the Finish button.

   Note that it might take some time for the helloworld application and its Maven dependencies to get imported. Once all the dependencies are imported, the New Project Example window appears.

8. Click the Finish button.
9. In the Server view select the Red hat JBoss EAP.

10. Click the Start the Server icon.

    Figure 3.2. Click the Start the Server icon

    

11. In the Project Explorer view right-click the jboss-helloworld-rs → Run Ad → Run on Server.

    The Run on Server window appears.

12. Click the Finish button.

    The helloworld application opens in the internal CodeReady Studio web browser.

13. Choose between the JSON or XML format.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.

3. Click File → New → Other.

   The New window appears.

4. Enter JavaScript in the search field.
5. Select JavaScript Project.

6. Click the Next button.

   The Create a JavaScript project window appears.

7. Name your project.

   All other fields are populated automatically.

8. Click the Finish button.

   The Open Associated Perspective window appears.

9. Click the Open Perspective button.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.

3. Click File → New → Other.

   The New window appears.

4. Enter npm in the search field.
5. Select npm Init.

6. Click the Next button.

   The npm Initialization Wizard window appears.

7. Click the Browse Workspace button to select the base directory for the package.json file.

8. Click the Finish button.

   The Open Associated Perspective window appears.

9. Click the Open Perspective button.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.

3. Click File → New → File.

   The Create New File window appears.

4. Select a parent folder for the file.

5. Name the file.

   For example index.js.

6. Click the Finish button.

Procedure

1. Start CodeReady Studio.

2. Click File → Import.

   The Import window appears.

3. Expand the General folder.
4. Select Existing Project into Workspace.
5. Click the Next button.
6. Click the Browse button to locate your existing project.
7. Select the path to your project in the Projects field.
8. Click the Finish button.

Verification steps

1. Click Window → Perspective → Open Perspective → Other.

   The Open Perspective window appears.

2. Select JavaScript.

3. Click the Open button.

   The Project Explorer view appears.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.
3. Open Project Explorer.
4. Right-click target project → Run as → Node.js Application.

Procedure

1. Start CodeReady Studio.
2. Open Project Explorer.
3. Expand the target project.

4. Right-click the index.js → Debug as → Node Program.

   The Console appears, displaying the error log.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.

3. Click Window: → Show view → Other.

   The Show View window appears.

4. Enter Forge Console in the search Field.
5. Select Forge Console.
6. Click the Open button.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.

3. Press Ctrl+4.

   The Current Selection window appears.

4. Enter Project in the search field.

5. Select Project: New.

   The Project: New window appears.

6. Name your project. Note that the project name cannot include spaces or special characters. The only special characters allowed are periods (.), underscores (_), and dashes (-).
7. Click the Browse button to select the project location.
8. Click the down-arrow in the Stack field.
9. Select Java EE 7.
10. Click the Finish button.

Verification steps

1. Click Window → Show View → Other.

   The Show View window appears.

2. Select Project Explorer.

3. Click the Open button.

   The Project Explorer view appears.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.

3. Press Ctrl+4.

   The Current Selection window appears.

4. Enter JPA in the search field.

5. Select JPA: New Entity.

   The JPA: Setup window appears.

   Not that the Forge Console automatically detects any prerequisites that must be set up and prompts you to create those at runtime.

6. Click the Next button.

   The JPA: Connection Settings window appears.

   Ensure that the automatically generated values are correct.

7. Click the Next button.

   The JPA: New Entity window appears.

8. Name your entity.

   Note that the entity name cannot include spaces or special characters. The only special character allowed is underscore (_).

9. Click the Finish button.

Verification steps

1. Click Window → Show View → Other.

   The Show View window appears.

2. Select Project Explorer.

3. Click the Open button.

   The Project Explorer view appears.

4. Expand your Forge project.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.

3. Press Ctrl+4.

   The Current Selection window appears.

4. Enter Field in the search field.

5. Select JPA: New Field.

   The JPA: New Field window appears.

6. Click the down-arrow in the Target Entity field.
7. Select the entity for your project.
8. Name your new field.
9. Click the Finish button.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.

3. Press Ctrl+4.

   The Current Selection window appears.

4. Enter Scaffold in the search field.

5. Select Scaffold: Generate.

   The Scaffold: Generate window appears.

6. Click the down-arrow in the Scaffold Type field.
7. Select Angular JS.

8. Click the Next button.

   The Setup Facets window appears.

9. Ensure that the automatically generated values are correct.

10. Click the Next button.

    The Select JPA entities window appears.

11. Select the JPA entities for scaffolding.
12. Click the Finish button.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.

3. Click Window → Show View → Other.

   The Show View window appears.

4. Select Project Explorer.

5. Click the Open button.

   The Project Explorer view appears.

6. Right-click your Forge project → Runs as → Run on Server.

   The Run On Server window appears.

7. Select the server to use.

   For example Red Hat JBoss Enterprise Application Platform 7.0.

8. Click the Finish button.

   The Console view appears.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.

3. Press Ctrl+N.

   The New window appears.

4. Enter JPA in the search field.
5. Select JPA Project

6. Click the Next button.

   The New JPA Project window appears.

7. Name your project.

   Note that the name of the project cannot include spaces or special characters. The only special characters allowed are periods (.), underscores (_), and dashes (-).

8. Click the down-arrow in the Target runtime field.
9. Select the runtime server.
10. Ensure that the JPA version is set to 2.1.

11. Click the Next button.

    The Java window appears.

12. Select the source folder.

13. Click the Next button.

    The JPA Facet window appears.

14. Click the down-arrow in the Platform field.
15. Select Hibernate (JPA 2.1).

16. Add user libraries or set the JPA Implementation Type to Disable Library Configuration.

    For more information on how to set up user libraries, see Section 6.2, “Adding libraries”.

17. Click Add connection.

    The New Connection Profile window appears.

18. Enter Generic in the search field.
19. Select Generic JDBC.
20. Enter sakila in the Name field

21. Click the Next button.

    The Specify a Driver and Connection Details window appears.

22. Click the New Driver Definition icon.

    

    Click the New Driver Definition icon.

    The New Driver Definition window appears.

23. Select the Generic JDBC Driver.
24. Click the JAR List tab.
25. Click the Add JAR/Zip button.
26. Select the .jar file for the Sakila database.
27. Click the Properties tab.
28. Add jdbc:h2:tcp://localhost/./sakila to the Connection URL field.
29. Click the Driver Class field.

30. Click the three dots icon at the end of the Driver Class field.

    The Available Classes from Jar List window appears.

31. Select the Browse the Class option.

    The org.h2.Driver appears.

32. Click the OK button.
33. Enter sa to the User ID field.
34. Click the OK button.
35. Click the Finish button.

36. Click the Finish button.

    The Open Associated Perspective? window appears.

37. Click the Open Perspective button.

Procedure

1. Download Hibernate ORM from http://hibernate.org/orm/.
2. Extract the files from the .zip file.
3. Start CodeReady Studio.
4. Open Git Perspective.

5. Click Window → Preferences.

   The Preferences window appears.

6. Enter Libraries in the search field.
7. Select User Libraries under Java.

8. Click the New button.

   The New User Library window appears.

9. Name your user library.
10. Click the OK button.
11. Select your new user library.
12. Click the Add External JARs button.
13. Locate the directory you extracted the Hibernate ORM .zip file into.
14. Navigate to the /lib/required/ directory.
15. Select the .jar files.
16. Click the Apply and Close button.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.
3. Open Project Explorer.

4. Right-click the target JPA project → JPA Tools → Generate Tables from Entities.

   The Generate Tables from Entities window appears.

5. Ensure that the Use Console Configuration box is checked.
6. Click the Finish button.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.

3. Click Ctr+N.

   The Show View window appears.

4. Enter Hibernate in the search field.
5. Select Hibernate XML Mapping file (hbm.xml).

6. Click the Next button.

   The Create Hibernate XML Mapping file (hbm.xml) window appears.

7. Click the Add Class button to add classes.

8. Click the Add Package button to add packages.

   Alternatively, you can create an empty hbm.xml file by not selecting any packages or classes.

9. Check the depth control box to define the dependency depth used when choosing classes.
10. Click the Next button.
11. Select the parent directory.
12. Name your hbm.xml file .
13. Click the Finish button.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.

3. Click Ctr+N.

   The Show View window appears.

4. Enter Hibernate in the search field.
5. Select Hibernate Configuration file (cfg.xml).

6. Click the Next button.

   The Create Hibernate Configuration file (cfg.xml) window appears.

7. Select the parent directory.

8. Click the Next button.

   The Hibernate Configuration file (cfg.xml) window appears.

9. Name your cfg.xml file.
10. Click the down-arrow in the Database dialect field.
11. Select the relevant database.
12. Click the down-arrow in the Driver class field.
13. Select the relevant driver.
14. Click the down-arrow in the Connection URL field.
15. Select the relevant URL.
16. Click the Finish button.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.

3. Click Ctr+N.

   The Show View window appears.

4. Enter Hibernate in the search field.
5. Select Hibernate Console Configuration.

6. Click the Next button.

   The Create Hibernate Console Configuration window appears.

7. Name your configuration file .
8. Ensure that the Type is set to Core.
9. Select the relevant Hibernate version.
10. Click the Browse button to locate the target project.
11. Click the New button to configure a new Database connection.

12. Click the Setup button to setup the Property file.

    The Setup property file window appears.

13. Click the Create new button.

    The Create Hibernate Properties file (.properties) window appears.

14. Select the parent directory.
15. Name your .properties file.
16. Click the Finish button.
17. Click the Setup button setup the Configuration file.

18. Select the path to the target .cfg.xml file.

    For more information on how to create a new .cfg.xml file, see Section 6.5, “Creating a Hibernate configuration file”.

19. Click the OK button.
20. Click the Finish button.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.

3. Click Ctr+N.

   The Show View window appears.

4. Enter Hibernate in the search field.
5. Select Hibernate Configuration.

6. Click the OK button.

   The Hibernate Configurations view appears.

7. Right-click the target project → Edit Configuration.

   The Edit Configuration window appears.

8. Edit the scenery configurations.
9. Click the Apply button.
10. Click the OK button.

Procedure

1. Start CodeReady Studio.
2. Open Git Perspective.

3. Press Ctr+N.

   The New window appears.

4. Enter HTML5 in the search field.
5. Select HTML5 Project.

6. Click the Next button.

   The New Project Example window appears.

7. Click the down-arrow in the Target Runtime field.
8. Select the server.
9. Click the Next button.
10. Name your project.
11. Name your package.

12. Click the Finish button.

    Note that it might take some time for the project to generate.

    The New Project Example window appears.

13. Click the Finish button.

Verification steps

1. Click the Window → Show View → Other.

   The Show View window appears.

2. Select Project Explorer.

3. Click the Open button.

   The Project Explorer view appears.

Procedure

1. Start CodeReady Studio.
2. Open Project Explorer.
3. Expand the target project → src → main.

4. Right-click the webapp → New → HTML File.

   The New HTML File window appears.

5. Ensure the webapp directory is selected.
6. Name your file.
7. Click the Next button.
8. Select HTML5 jQuery Mobile Page (1.4).
9. Click the Finish button.

Procedure

1. Start CodeReady Studio.
2. Open Project Explorer.
3. Expand the target project → src → main → webapp.
4. Right-click the .html file.

5. Click Open With → JBoss Tools HTML Editor.

   The Pallet view opens.

6. Click the Pallet view.
7. Expand jQuery Mobile.

8. Click the Page icon.

   The Insert Tag window appears.

9. Name the Header.
10. Name the Footer.
11. Click the Finish button.

Procedure

1. Start CodeReady Studio.
2. Start Git Perspective.

3. Click Window → Preferences.

   The Preferences window appears.

4. Enter JBoss Tools in the search field.

5. Select JBoss Runtime Detection.

   The JBoss Runtime Detection window appears.

6. Click the Add button.
7. Locate the directory containing the runtime server.
8. Click the OK button.
9. Click the Apply and Close button.

Verification steps

1. Click the Window → Show View → Other.

   The Show View window appears.

2. Type Servers in the search field.
3. Select Servers.

4. Click the Open button.

   The Servers view appears.

Procedure

1. Start CodeReady Studio.

2. Press Ctrl+N.

   The New window appears.

3. Enter Server in the search field.
4. Select Server.

5. Click the Next button.

   The Define a New Server window appears.

6. Select the server type.
7. Click the Next button.
8. Check the Remote box.
9. Select one of the Controlled by options.
10. Check the Server lifecycle externally managed box.
11. Assign runtimes to the server.

12. Click the Next button.

    The Remote System Integration window appears.

13. Click the Browse button in the Remote Server Home field.
14. Specify the path to the directory that contains the remote server.
15. Click the Finish button.

Verification steps

1. Click the Window → Show View → Other.

   The Show View window appears.

2. Type Servers in the search field.
3. Select Servers.

4. Click the Open button.

   The Servers view appears.

Procedure

1. Start CodeReady Studio.
2. Start Project Explorer.

3. Right-click the target project → Run as → Run on Server.

   The Run on Server window appears.

4. Ensure that the Choose an existing server box is checked.
5. Expand localhost to select the server on which to deploy
6. Click the Finish button.
7. The Console view appears