3. Getting ready for your own work with the ORIGAM platform

docs start
1

:raising_hand_man: This article is your guide to kickstarting application development with the ORIGAM Platform.

:rewind: New here? If you’re still deciding whether ORIGAM is the right fit for you, check out the previous chapter on the Introduction.

Basic Requirements

Excited to get started? Here’s what you need:

  • PC or Mac: At least 16 GB of RAM (32 GB recommended) and a minimum of 256 GB disk space (512 GB preferred).
  • Operating System: MS Windows, macOS, or Linux with virtual MS Windows.
  • ORIGAM Architect: The integrated development environment (IDE) for modeling ORIGAM applications.
  • Docker Desktop: Runs the application, database, and web server in Docker containers.
  • Web Browser: Use Google Chrome or another modern browser for the client web application.

Additional Tools

Here are some optional tools that can enhance your experience:

Data Management
Consider using Azure Data Studio for easier database management. It’s compatible with MS SQL Server and PostgreSQL and runs on Windows, macOS, and Linux. For more info, check out this article. You can also use MS SQL Server Management Studio (SSMS) if you’re on Windows.

Version Tracking and Collaboration
For more advanced version control and collaboration, we recommend Git along with platforms like GitHub, GitLab, or BitBucket.

Code Editing
Initially, you won’t need to edit code, but as you develop custom modules, you might find tools like MS Visual Studio Code, MS Visual Studio, or Notepad++ useful.

Recommended Environment for Local Development

Here’s our ideal setup:

  • PC with MS Windows or Mac with macOS
  • ORIGAM Architect desktop app
  • Docker container 1: ORIGAM Server
  • Docker container 2: Database server
  • Web Browser

This is our suggested configuration, but if you already have a local database server set up, you can skip installing another one in Docker.

Installation Steps

Database Server

If you don’t have a database server installed, follow these steps:

  1. Download and install Docker Desktop from here.

  2. Choose your database server: MS SQL or PostgreSQL.

    :information_source: Unsure which to pick? Choose MS SQL if you’re on Windows, and PostgreSQL for macOS, especially on Apple Silicon. Check out this comparison.

  3. Create a new Docker container with your chosen database server or download one here.

    :information_source: New to Docker? Read this or refer to the Docker documentation.
    :information_source: If you have an M1 or newer Mac, check this guide.

  4. Start the Docker container and ensure it’s running correctly.

ORIGAM Architect

  1. Install the latest stable release of ORIGAM Architect.
    • Windows Users: Download here (Assets / OrigamSetup.msi) and install it.
    • Mac Users: Since the app runs only as a Windows desktop app, you’ll need a virtual machine. Options include Parallels Desktop or Oracle VM VirtualBox (note: VirtualBox does not support ARM/Apple Silicon). Follow the same instructions for Windows once your virtual machine is set up.

ORIGAM Server
This server is essential for your first ORIGAM project. For installation details, refer to the server installation guide.

Additional Tools
Feel free to download auxiliary tools like Azure Data Studio, Visual Studio Code, or Git. All are available for both Windows and Mac.

~

Once you have installed all the necessary components, including ORIGAM Architect, the Server, and the database server, you’re all set to start local development with the ORIGAM platform! :+1:

:next_track_button: Ready to embark on your first project? Jump to the next chapter on Platform Overview!