Skip to main content

Environment Preparation

Before you start using OSI, you need to prepare your development environment. This section will guide you through the necessary prerequisites and setup.

System Requirements​

Supported Operating Systems​

  • macOS 10.15 or later
  • Linux (Ubuntu 20.04 LTS or later)
  • Windows 7 or later

Required Software​

  • Node.js 16.x or later
  • npm 8.x or later
  • Electron 22.x or later (for Electron applications only)

Development Environment Setup​

1. Install Node.js and npm​

Download and install Node.js from the official website. The installation will include npm.

Verify the installation:

node --version
npm --version

2. Install Electron (for Electron applications)​

Install Electron globally or as a project dependency:

# Global installation
npm install -g electron

# Or as a project dependency
npm install electron --save-dev

3. Development Tools​

Recommended development tools:

  • Visual Studio Code or your preferred IDE
  • Git for version control
  • Chrome DevTools for debugging (for Electron applications)

Project Structure​

A typical Node.js project structure should look like this:

your-project/
├── src/
│   └── index.ts    # Main application code
├── package.json
└── tsconfig.json

Next Steps​

Once your environment is set up, proceed to the Installation and Configuration section to learn how to integrate OSI into your project.