Skip to content

Planning Your Project

Ride Let's Build screen for selecting a project or creating a new one.

Click Go To Project to go to any of your projects.

Ride project splash screen to choose whether to plan changes or go to code.

Known IssueTroubleshootingStatus
Test View -> button shows 404 page.The static web app for the Test environment doesn’t get deployed until you make your first publish to the test environment.Reported on Github.

Your project has session/branch management built into it. Meaning that when you are working on your project, rIDE automatically creates a branch just for your user. rIDE automatically manages your branch and merges it to test (develop) and live (main) when you commit your changes.

If you want to share a project with users that you’ve added to your workspace, the creator of the project will have to export and the collaborator will have to import the configuration secrets to successfully build and run the solution. You can plan the project without these secrets but you won’t be able to run the project.

Steps to share a workspace projects:

  • The creator of the project must click Export Secrets JSON. rIDE will show you where the file has been downloaded.
  • The creator of the project sends the file to the collaborator.
  • The collaborator clicks Import Secrets JSON and selects the file that was shared with them.

Ride software planning screen with chat and sidebar that shows results.

rIDE helps you plan and manage workflows/tasks in your project. In the planning screen, describe the app you are trying to build.

rIDE will attempt to break your app into the following:

  • Workflows
  • Definitions
  • User Types

Definitions: What are the common objects in the app that a user will typically interact with. For example a task or a product item.

Definition Changes modal with Acccept Changes button or chat input.

User Types: Who are the different users that will be using the app. For example: Admin, Customer, Employee, etc.

User Type Changes modal with Acccept Changes button or chat input.

Workflow: What are the workflows of the app. For example: A user will need to login to the app, then add a task, and the task will show up on a list.

Workflow Changes modal with Acccept Changes button or chat input.

rIDE will take the app you described and break it into these three categories which will be used when building your app.

Click Start Plan to begin architecting and implementing the workflow.

Ride software planning screen with chat conversation and sidebar results.

NOTE: The “Mark Done” button is when the developer is done implementing the task, not when you are done planning it with the AI.

Known IssueTroubleshootingStatus
Users think Mark Done is when they are done planning the workflow and accidently click it.Need to ask the AI to recreate the workflow or contact support@codebuddy.com.Not Reported.

Checklist:

  • Put in your concept and plan the Workflows, User Types, and Definitions.