Skip to main content

Getting Started

This guide will help you set up the App Builder front-end project locally.

Prerequisites​

Before you begin, ensure you have the following installed:

  • Node.js (v16 or higher)
  • PNPM (preferred package manager)
  • Vite.js (bundler)
  • Git (for version control)

Installation Steps​

  1. Clone the Repository

    git clone https://github.com/oarkflow/oarkflow.git
    cd app-builder

  2. Install Dependencies

    pnpm install

  3. setup .env file

     cp .env.example .env

  4. Start the Development Server

    pnpm dev

This will start the server at http://localhost:5173.

Folder Structure​

app-builder/
├── src/
│   ├── components/       # Reusable components
│   ├── pages/            # Main pages (web-build, app-build, etc.)
│   ├── assets/           # Images, icons, styles
│   ├── utils/            # Helper functions
│   └── App.tsx           # Main app entry point
├── public/               # Static files
├── .env                  # Environment variables
├── package.json          # Project metadata
└── README.md             # Project overview

Next Steps​

Learn about Web-Build and App-Build functionalities. For user authentication features and settings, refer to the Auth System documentation.

These documents provide a clear introduction and installation guide, ensuring your users and developers can quickly understand and set up the project. You can expand sections like prerequisites or folder structure as needed.