Code Generation
Setup Code Generation
1
Open the Code Generator menu
- Click on the 'Code' button on the top right corner to open the Code Generator menu.
2
Download the Code Client
- Click the 'Download' Button for Mac or Linux or Windows.
Code Client MacOS
1
Install Code Client on Mac
- Drag and drop the Codebricks Code Client into Applications.
2
Start the Code Client
- Open the Applications folder.
- Open the Codebricks Code Client.
Code Client Linux
1
Install Code Client on Linux
- Run `sudo apt-get install ./codebricks-codeclient.deb`
2
Start the Code Client
- Open the Applications.
- Open the Codebricks Code Client.
- Or run `./codebricks-codeclient`
Code Client Windows
1
Install Code Client on Windows
- Open the `codebricks-codeclient.exe`.
2
Start the Code Client
- Open the Applications folder.
- Or go to your Desktop.
- Open the Codebricks Code Client.
Configure Code Client
1
Open the Code Generator menu
- Click on the 'Code' button to open the Code Generator menu.
2
Login to Code Client
- Click the 'Login' button.
- The browser may ask for confirmation to open the Code Client.
- The Code Client will show 'Login was successful'.
The Code Client is connected
Select Aggregates and Path
1
Continue
- Open the browser again and select the 'task' Aggregate.
2
Configure Code Path
- Click the 'Configure Code Path' button.
- The browser may ask for confirmation to open the Code Client.
3
Set the Code Path in the Client
- Click the 'Set Path' button.
- Select a directory for the Code project.
- Click the 'Done' button.
Code generation is configured
Select Use Cases
1
Select 'add task' Use Case
- Click the 'add task' Use Case.
2
Open the Use Case menu
- Click the Use Case menu icon on the left side.
3
Set generation status to ready
- Set the generation status from 'planned' to 'ready'.
Planned Use Cases have a blue border, the Code Generator wont generate its code.
Ready Use Cases have a gray border, the Code Generator generates its code.
Use case is ready for Code Generation
Generate the Code
1
Open the Code Generator menu
- Click on the 'Code' button to open the Code Generator menu.
2
Start Code Generation
- Click the 'Generate Code' button.
3
Generating code
- Wait until the activity indicator disappears and 'Code Generation done' is displayed under the button.
- Open the selected Path with an IDE or Text Editor.
The generated code